> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pilotstatus.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar Formulários Instantâneos

> Os Formulários Instantâneos da Página vinculada, lidos ao vivo da Meta, cada um com as perguntas, as caixas de consentimento e a configuração guardada na Pilot Status (`config`, ou `null` quando nunca configurado). Também devolve `numberIsOfficial` e, para um número oficial (Meta Cloud API), os templates **APROVADOS** que o número do vínculo pode enviar automaticamente (`templates`, vazio num número não oficial).

`consentAvailable: false` significa que as caixas do formulário não puderam ser lidas — a lista é desconhecida, não vazia. `formsTruncated: true` significa que a Página tem mais formulários do que a Pilot Status leu. Tokens OAuth/MCP precisam de `integrations:manage` (ADMIN ou OWNER do workspace) em todos os verbos, leituras incluídas. Escopo: uma chave com escopo de número, ou uma credencial da conta inteira com `x-whatsapp-number-id`, atua só nos vínculos daquele número; uma credencial da conta inteira sem o header vê o workspace todo.



## OpenAPI

````yaml openapi.pt.json GET /v1/lead-pages/{pageLinkId}/forms
openapi: 3.1.0
info:
  title: API Pilot Status
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    API REST pública do Pilot Status. Autentique com o header `x-api-key:
    ps_...` (ou `x-api-key-id`). Base URL: https://pilotstatus.com.br
servers:
  - url: https://pilotstatus.com.br
security:
  - apiKey: []
  - apiKeyId: []
paths:
  /v1/lead-pages/{pageLinkId}/forms:
    get:
      tags:
        - Ads
      summary: Listar Formulários Instantâneos da Página
      description: >-
        Os Formulários Instantâneos da Página vinculada, lidos ao vivo da Meta,
        cada um com as perguntas, as caixas de consentimento e a configuração
        guardada na Pilot Status (`config`, ou `null` quando nunca configurado).
        Também devolve `numberIsOfficial` e, para um número oficial (Meta Cloud
        API), os templates **APROVADOS** que o número do vínculo pode enviar
        automaticamente (`templates`, vazio num número não oficial).


        `consentAvailable: false` significa que as caixas do formulário não
        puderam ser lidas — a lista é desconhecida, não vazia. `formsTruncated:
        true` significa que a Página tem mais formulários do que a Pilot Status
        leu. Tokens OAuth/MCP precisam de `integrations:manage` (ADMIN ou OWNER
        do workspace) em todos os verbos, leituras incluídas. Escopo: uma chave
        com escopo de número, ou uma credencial da conta inteira com
        `x-whatsapp-number-id`, atua só nos vínculos daquele número; uma
        credencial da conta inteira sem o header vê o workspace todo.
      operationId: get_lead-page-forms
      parameters:
        - name: pageLinkId
          in: path
          required: true
          description: >-
            O id do vínculo (`linked[].pageLinkId` de `GET /v1/lead-pages`), não
            o id da Página do Facebook.
          schema:
            type: string
          example: cmgpl0001ab12cd34ef56
        - name: x-whatsapp-number-id
          in: header
          required: false
          description: >-
            Restringe uma credencial da conta inteira a um número (o id dele ou
            o id da instância, de `GET /v1/numbers`). Sem ele, uma credencial da
            conta inteira vê o workspace todo; uma chave com escopo de número vê
            sempre só o próprio número.
          schema:
            type: string
          example: num_01HZX...
      responses:
        '200':
          description: Formulários da Página
          content:
            application/json:
              example:
                forms:
                  - formId: '987654321098765'
                    formName: Orçamento — Outubro
                    status: ACTIVE
                    questions:
                      - key: full_name
                        label: full_name
                        type: FULL_NAME
                        options: []
                      - key: qual_ambiente
                        label: Qual ambiente você quer reformar?
                        type: CUSTOM
                        options:
                          - key: cozinha
                            value: Cozinha
                    consentCheckboxes:
                      - key: whatsapp_optin
                        text: Aceito receber mensagens no WhatsApp
                    consentAvailable: true
                    config:
                      formId: '987654321098765'
                      formName: Orçamento — Outubro
                      consentDisclaimerKey: whatsapp_optin
                      autoSendEnabled: true
                      templateId: null
                      freeText: Olá {{nome}}, recebemos seu pedido de orçamento!
                      variableMap:
                        nome:
                          source: field
                          key: full_name
                      updatedAt: '2026-10-21T09:30:00.000Z'
                formsTruncated: false
                numberIsOfficial: false
                templates: []
        '400':
          description: >-
            `NUMBER_REQUIRED` (concessão OAuth por número sem
            `x-whatsapp-number-id`) ou `NUMBER_NOT_FOUND` (chave com escopo de
            número cujo número foi apagado)
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: >-
                  Provide x-whatsapp-number-id for a per-number connection |
                  Envie o header x-whatsapp-number-id para uma conexão por
                  número
                code: NUMBER_REQUIRED
        '401':
          description: Header `x-api-key` / `x-api-key-id` ausente ou inválido
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Unauthorized
        '403':
          description: >-
            O número está fora do escopo da credencial (`NUMBER_NOT_IN_GRANT`),
            ou token OAuth cujo papel no workspace não tem `integrations:manage`
            (`PERMISSION_DENIED`)
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: >-
                  This credential is not granted access to that WhatsApp number
                  | Esta credencial não tem acesso a esse número de WhatsApp
                code: NUMBER_NOT_IN_GRANT
        '404':
          description: >-
            Vínculo de página não encontrado: nunca vinculado, já desvinculado
            ou de outro workspace
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Page link not found | Vínculo de página não encontrado
                code: NOT_FOUND
        '409':
          description: >-
            A Pilot Status não tem mais acesso à Página
            (`PAGE_MISSING_PERMISSION`, com `missingTasks`)
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: >-
                  Pilot Status does not have the required permissions on this
                  Page yet. | A Pilot Status ainda não tem as permissões
                  necessárias nesta página.
                code: PAGE_MISSING_PERMISSION
                missingTasks:
                  - PAGE_ACCESS
        '500':
          description: Erro interno
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Internal server error | Erro interno do servidor
                code: INTERNAL_ERROR
        '502':
          description: Não foi possível consultar a Meta. Tente de novo.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: >-
                  Could not reach Meta right now. Try again. | Não foi possível
                  consultar a Meta agora. Tente novamente.
                code: LEADS_LOOKUP_UNAVAILABLE
        '503':
          description: A captura de leads não está configurada nesta instalação
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: >-
                  Meta lead capture is not configured on this installation. |
                  Captura de leads da Meta não configurada nesta instalação.
                code: LEADS_NOT_CONFIGURED
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Sua chave de API ps_
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: Id da chave de API (alternativa ao x-api-key)

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.