GET/api/v4/connected-accounts/{connectedAccountId}/details

Obter detalhes de uma conta conectada

Retorna os detalhes de uma única conta conectada do Google ou do Facebook pelo ID.

Requer uma chave de API. Consulte Autenticação para ver o formato do cabeçalho e a rotação de chaves.

Parâmetros

Caminho

NomeTipoObrigatórioDescrição
connectedAccountIdstringobrigatórioUUID of the connected account (from the list connected accounts endpoint).

Respostas

200Connected account details.
Response
{  "data": {    "connectedAccountDetails": {      "details": {        "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.

Busca o registro completo de detalhes de uma única conta conectada, identificada por seu connectedAccountId. Isso retorna os mesmos campos de um registro do endpoint de listagem, mas com escopo restrito a uma conta, o que é menos custoso do que percorrer todas as páginas da lista quando você já tem o ID.

Caso de uso: consultar periodicamente uma conta recém-conectada. Depois que um cliente conclui o fluxo de conexão com o Google, você tem um connectedAccountId, mas a busca de correspondências é executada de forma assíncrona. Consulte este endpoint periodicamente e observe requestMatchesStatus: ele passa de MATCH_IN_PROGRESS para MATCH_COMPLETED quando as sugestões estão prontas, momento em que você pode consultá-las no endpoint connection-suggestions.

Caso de uso: exibir uma mensagem solicitando reautenticação. Antes de enviar atualizações por meio de uma conta, consulte status e connectivityIssue. Um status diferente de CONNECTED ou um connectivityIssue preenchido significa que a autorização OAuth expirou; solicite ao cliente que se reconecte no seu aplicativo em vez de tentar uma publicação que falhará. connectedLocationsCount informa quantos locais da Listings API estão atualmente vinculados à conta.

Request
curl -X GET 'https://listingsapi.com/api/v4/connected-accounts/<connectedAccountId>/details' \  -H "Authorization: API $LISTINGSAPI_KEY"