> ## 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 Páginas do Lead Ads

> As Páginas do Facebook vinculadas aos seus números de WhatsApp para a captura do **Meta Lead Ads**, e as Páginas que você ainda pode vincular. Um lead enviado num Formulário Instantâneo de uma Página vinculada fica guardado no número dessa Página (leia com [`GET /v1/leads`](/pt-BR/api/leads)).

Não há etapa de login na Meta: o anunciante compartilha a Página com o portfólio empresarial da Pilot Status (`partnerBusinessId`) no Meta Business Manager e dá as tarefas da Página ao usuário do sistema da Pilot Status. `candidates[].missingTasks` lista o que ainda falta (`MODERATE`, `MANAGE_LEADS`, ou `PAGE_ACCESS` quando a Página nem foi atribuída ao usuário do sistema); lista vazia significa pronta para vincular, `null` significa que não foi possível consultar a Meta.

Uma Página só pode ser vinculada quando a empresa dona dela também é dona da WABA de um dos seus números **oficiais** (Meta Cloud API); sem nenhum, `candidates` vem vazio e `eligibilityBlocker` é `NO_OFFICIAL_NUMBER`. Em `linked`, `subscribedAt: null` significa que a Meta **não** está enviando os leads daquela Página — `subscriptionError` diz o motivo (`META_PERMISSION_MISSING`, `PAGE_ACCESS_MISSING`, `PAGE_NOT_SHARED`, `PAGE_BUSINESS_MISMATCH`, …) e a [ressincronização](/pt-BR/api/lead-pages) tenta de novo. `candidatesLookup` é `ok`, `unavailable` ou `not_configured`.

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
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:
    get:
      tags:
        - Ads
      summary: Listar Páginas do Lead Ads
      description: >-
        As Páginas do Facebook vinculadas aos seus números de WhatsApp para a
        captura do **Meta Lead Ads**, e as Páginas que você ainda pode vincular.
        Um lead enviado num Formulário Instantâneo de uma Página vinculada fica
        guardado no número dessa Página (leia com [`GET
        /v1/leads`](/pt-BR/api/leads)).


        Não há etapa de login na Meta: o anunciante compartilha a Página com o
        portfólio empresarial da Pilot Status (`partnerBusinessId`) no Meta
        Business Manager e dá as tarefas da Página ao usuário do sistema da
        Pilot Status. `candidates[].missingTasks` lista o que ainda falta
        (`MODERATE`, `MANAGE_LEADS`, ou `PAGE_ACCESS` quando a Página nem foi
        atribuída ao usuário do sistema); lista vazia significa pronta para
        vincular, `null` significa que não foi possível consultar a Meta.


        Uma Página só pode ser vinculada quando a empresa dona dela também é
        dona da WABA de um dos seus números **oficiais** (Meta Cloud API); sem
        nenhum, `candidates` vem vazio e `eligibilityBlocker` é
        `NO_OFFICIAL_NUMBER`. Em `linked`, `subscribedAt: null` significa que a
        Meta **não** está enviando os leads daquela Página — `subscriptionError`
        diz o motivo (`META_PERMISSION_MISSING`, `PAGE_ACCESS_MISSING`,
        `PAGE_NOT_SHARED`, `PAGE_BUSINESS_MISMATCH`, …) e a
        [ressincronização](/pt-BR/api/lead-pages) tenta de novo.
        `candidatesLookup` é `ok`, `unavailable` ou `not_configured`.


        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-pages
      parameters:
        - 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: Páginas vinculadas e vinculáveis
          content:
            application/json:
              example:
                linked:
                  - pageLinkId: cmgpl0001ab12cd34ef56
                    pageId: '102345678901234'
                    pageName: MM Design
                    whatsappNumberId: num_01HZX...
                    subscribedAt: '2026-10-06T10:15:00.000Z'
                    subscriptionError: null
                    linkedAt: '2026-10-06T10:14:58.000Z'
                    leadsCount: 42
                candidates:
                  - pageId: '109876543210987'
                    pageName: MM Design Outlet
                    missingTasks:
                      - MANAGE_LEADS
                configured: true
                partnerBusinessId: '123456789012345'
                candidatesLookup: ok
                eligibilityBlocker: null
        '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: Token OAuth cujo papel no workspace não tem `integrations:manage`
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: >-
                  Your workspace role does not allow this action
                  (integrations:manage).
                code: PERMISSION_DENIED
        '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
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.