Synupv1
Criar chave
v1Recursos/Connections/getListar contas conectadas

Listar contas conectadas

Retorna as contas de publisher/redes sociais conectadas da sua agência (Google, Facebook, Instagram, LinkedIn, TikTok e outras), opcionalmente filtradas por cliente ou plataforma.

get/api/v1/connections
connections:read
Parâmetros de consulta
clientIdstringopcional
Restringe os resultados a um cliente. Quando sua chave está limitada a clientes específicos, os resultados já são pré-filtrados para esses clientes mesmo que isto seja omitido.
platformstringopcional
Restringe os resultados a uma plataforma, ex.: facebook, google.
credentialsValidbooleanopcional
Restringe a contas cujas credenciais armazenadas estão (true) ou não estão (false) atualmente válidas.
fetchStatusstringopcional
Restringe a contas com este status de busca.
cursorstringopcional
Cursor de paginação da nextCursor de uma resposta anterior.
limitintegeropcional
Máximo de contas a retornar, 1–100. O padrão é 20.
Resposta
dataobjectopcional
accountsarray of objectopcional
As contas conectadas correspondentes.
idstringopcional
Identificador único da conta conectada.
platformstringopcional
A plataforma à qual esta conta se conecta, ex.: google, facebook, instagram.
displayNamestringopcional
Nome de exibição da conta conectada.
providerAccountIdstringopcional
O identificador próprio da plataforma para esta conta.
credentialsValidbooleanopcional
Se as credenciais armazenadas estão atualmente válidas.
fetchStatusstringopcional
Status de busca atual para esta conta, ex.: idle, fetching.
fetchErrorstringopcional
A última mensagem de erro de busca, ou null.
errorTagstringopcional
Um código de erro curto legível por máquina, ou null.
gmbGroupIdsarray of stringopcional
IDs de grupo do Google Business Profile associados a esta conta, se houver.
expiresAtstringopcional
Quando o token de acesso desta conta expira, como timestamp ISO 8601, ou null.
dataAccessExpiresAtstringopcional
Quando a janela de acesso a dados da Meta para esta conta expira, como timestamp ISO 8601, ou null.
channelstringopcional
O canal pelo qual esta conexão foi feita.
clientIdstringopcional
ID do cliente ao qual esta conta pertence, ou null para uma conexão de toda a agência.
synupLocationIdstringopcional
Identificador de local legado. Obsoleto — prefira clientLocationId.
clientLocationIdstringopcional
ID do local ao qual esta conta está vinculada, ou null. Prefira este a synupLocationId.
fetchedListingsCountnumberopcional
Número de listagens que esta conta buscou.
lastFetchedAtstringopcional
Quando esta conta completou sua última busca, como timestamp ISO 8601, ou null.
connectionStatusstring (CONNECTED | MISSING | RENEW | DISCONNECTED | SUSPENDED | SUGGESTED_MATCH)opcional
Saúde geral desta conexão: CONNECTED, MISSING, RENEW, DISCONNECTED, SUSPENDED ou SUGGESTED_MATCH.
createdAtstringopcional
Quando esta conta foi conectada, como timestamp ISO 8601.
updatedAtstringopcional
Quando esta conta foi atualizada por último, como timestamp ISO 8601.
nextCursorstringopcional
Cursor de paginação para a próxima página, ou null quando não há mais resultados.
totalCountnumberopcional
Número total de contas correspondentes à solicitação.
Erros
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
get/api/v1/connections
Sua chave de API
clientId
platform
credentialsValid
fetchStatus
cursor
limit
{
  "data": {
    "accounts": [
      {
        "id": "conn_1",
        "platform": "google",
        "displayName": "Acme Dental — Google",
        "providerAccountId": "112233445566",
        "credentialsValid": true,
        "fetchStatus": "ok",
        "fetchError": null,
        "errorTag": null,
        "gmbGroupIds": [],
        "expiresAt": null,
        "dataAccessExpiresAt": "2026-05-01T00:00:00.000Z",
        "channel": "local",
        "clientId": "cli_123",
        "synupLocationId": null,
        "clientLocationId": "loc_456"
      }
    ],
    "nextCursor": null,
    "totalCount": 1
  }
}