> ## 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 contas de anúncios

> As contas de anúncios da Meta que este workspace conectou, para a Pilot Status resolver os **nomes** do anúncio, do conjunto de anúncios e da campanha do seu tráfego Click-to-WhatsApp, mais as contas que você ainda pode conectar.

Não há etapa de login na Meta: o anunciante adiciona o portfólio empresarial da Pilot Status (`partnerBusinessId`) como **parceiro** da conta de anúncios no Meta Business Manager, e a Pilot Status lê com o próprio usuário do sistema.

**Só credencial da conta inteira** (chave com escopo de número é recusada com `403 NUMBER_SCOPE_NOT_ALLOWED`): uma conta de anúncios pertence ao workspace, não a um número. Tokens OAuth/MCP precisam de `integrations:manage` (ADMIN ou OWNER do workspace) em todos os verbos, leituras incluídas.

`linked` são os vínculos ativos; `sharingActive` é `true` enquanto a concessão de parceiro continua valendo, `false` quando o anunciante a revogou e `null` quando não foi possível consultar a Meta agora (nunca leia `null` como revogada). `candidates` são contas compartilhadas com a Pilot Status que comprovadamente são deste workspace — um anúncio delas já chegou a um dos seus números — e ainda não vinculadas; um workspace novo começa com a lista vazia. `sharingLookup` é `ok`, `unavailable` (a Meta não respondeu; `linked` volta mesmo assim) ou `not_configured`.



## OpenAPI

````yaml openapi.pt.json GET /v1/ads/accounts
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/ads/accounts:
    get:
      tags:
        - Ads
      summary: Listar contas de anúncios
      description: >-
        As contas de anúncios da Meta que este workspace conectou, para a Pilot
        Status resolver os **nomes** do anúncio, do conjunto de anúncios e da
        campanha do seu tráfego Click-to-WhatsApp, mais as contas que você ainda
        pode conectar.


        Não há etapa de login na Meta: o anunciante adiciona o portfólio
        empresarial da Pilot Status (`partnerBusinessId`) como **parceiro** da
        conta de anúncios no Meta Business Manager, e a Pilot Status lê com o
        próprio usuário do sistema.


        **Só credencial da conta inteira** (chave com escopo de número é
        recusada com `403 NUMBER_SCOPE_NOT_ALLOWED`): uma conta de anúncios
        pertence ao workspace, não a um número. Tokens OAuth/MCP precisam de
        `integrations:manage` (ADMIN ou OWNER do workspace) em todos os verbos,
        leituras incluídas.


        `linked` são os vínculos ativos; `sharingActive` é `true` enquanto a
        concessão de parceiro continua valendo, `false` quando o anunciante a
        revogou e `null` quando não foi possível consultar a Meta agora (nunca
        leia `null` como revogada). `candidates` são contas compartilhadas com a
        Pilot Status que comprovadamente são deste workspace — um anúncio delas
        já chegou a um dos seus números — e ainda não vinculadas; um workspace
        novo começa com a lista vazia. `sharingLookup` é `ok`, `unavailable` (a
        Meta não respondeu; `linked` volta mesmo assim) ou `not_configured`.
      operationId: get_ads-accounts
      responses:
        '200':
          description: Contas de anúncios vinculadas e vinculáveis
          content:
            application/json:
              example:
                linked:
                  - adAccountId: act_1234567890
                    adAccountName: MM Design
                    linkedAt: '2026-10-05T14:02:11.000Z'
                    sharingActive: true
                candidates:
                  - adAccountId: act_9876543210
                    adAccountName: MM Design — Black Friday
                    accountStatus: 1
                partnerBusinessId: '123456789012345'
                sharingLookup: ok
        '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: >-
            Chave com escopo de número (este endpoint exige uma credencial da
            conta inteira), 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 endpoint requires a tenant-scoped API key
                code: NUMBER_SCOPE_NOT_ALLOWED
        '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.