/api/v4/connected-accountsListar contas conectadas
Retorna as contas do Google e do Facebook conectadas à sua conta da Listings API, com a integridade da conexão e a contagem de locais vinculados.
Parâmetros
Query
| Nome | Tipo | Obrigatório | Descrição | Padrão |
|---|---|---|---|---|
| page | integer | opcional | 1-based page number. | 1 |
| perPage | integer | opcional | Records per page. | 20 |
| publisher | string | opcional | Narrow to one publisher by account type: `GoogleAccount`, `FacebookAccount`, `AppleAccount`, `YelpAccount`, `TripadvisorAccount`, `LinkedinAccount`, `PinterestAccount`, or `TwitterAccount`. | — |
| status | string | opcional | Narrow to one connection status: `Connected`, `NotConnected`, or `ConnectionIssue`. Note the mixed case, and that these are not the values the response's own `status` field uses. | — |
Respostas
200List of connected accounts with pagination metadata.
{ "data": { "connectedAccountsInfo": { "pageInfo": { "hasNextPage": false, "hasPreviousPage": false, "totalPages": 1, "totalRecords": 1 }, "records": [ { "accountId": "12345", "clientName": "owner@brightsmile-dental.com", "connectedAccountId": "4f712c17-4f95-42dd-90f4-97171a2e67b5", "connectedAccountType": "GoogleAccount", "connectedLocationsCount": 0, "connectivityIssue": null, "email": "owner@brightsmile-dental.com", "lastFetchMatchesRequestedAt": "2026-07-06 21:43:07 UTC", "remarks": null, "requestMatches": false, "requestMatchesStatus": "MATCH_COMPLETED", "status": "CONNECTED" } ] } }}401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.
Retorna todas as contas do Google Business Profile e do Facebook Pages autorizadas a se conectar à sua conta da Listings API. Cada registro contém a integridade da conexão (status, connectivityIssue), a quantidade de locais vinculados (connectedLocationsCount) e o estado da última busca de correspondências (requestMatchesStatus).
Caso de uso: auditar a integridade da conexão antes de uma sincronização. Execute esta operação no início de uma tarefa noturna para encontrar contas cujas credenciais expiraram. Qualquer registro com connectivityIssue não nulo ou com status diferente de CONNECTED exige que o cliente autorize novamente a conexão pelo fluxo de conexão; ignore esses registros para não desperdiçar uma chamada a trigger-matches com uma credencial inválida.
Caso de uso: identificar um connectedAccountId para chamadas subsequentes. Os endpoints trigger-matches, fetch-listings, folders e details usam connectedAccountId como chave. Liste as contas, escolha aquela cujo email corresponde ao cliente e reutilize seu connectedAccountId.
A paginação e a filtragem usam parâmetros de consulta simples, sem aninhamento, e não JSON: page, perPage, publisher e status. Não há parâmetros pageInfo, filters ou sort, nem como alterar a ordenação: os resultados são sempre ordenados pelo e-mail da conta, em ordem crescente. Qualquer outro parâmetro que você enviar será ignorado em vez de rejeitado, portanto, um pageInfo em JSON retorna silenciosamente a página 1.
curl -s 'https://listingsapi.com/api/v4/connected-accounts?page=1&perPage=20&publisher=GoogleAccount&status=Connected' \ -H "Authorization: API $LISTINGSAPI_KEY"O filtro status e o campo status não compartilham o mesmo vocabulário. O filtro aceita Connected, NotConnected ou ConnectionIssue; o valor de status em cada registro retornado é CONNECTED, MATCH_IN_PROGRESS ou CONNECTIVITY_ISSUE. Usar o próprio status de um registro como valor do filtro fornece um valor inválido para o enum e faz o endpoint retornar 400.
Leia pageInfo.hasNextPage e pageInfo.totalPages na resposta para decidir se deve buscar outra página. As chamadas a este endpoint são contabilizadas no limite de requisições da conta; uma resposta 429 inclui um cabeçalho Retry-After.
curl -X GET 'https://listingsapi.com/api/v4/connected-accounts' \ -H "Authorization: API $LISTINGSAPI_KEY"