Synupv1
Créer une clé
v1Ressources/Connexions/getLister les comptes connectés

Lister les comptes connectés

Renvoie les comptes publisher/sociaux connectés de votre agence (Google, Facebook, Instagram, LinkedIn, TikTok et autres), éventuellement filtrés par client ou plateforme.

get/api/v1/connections
connections:read
Paramètres de requête
clientIdstringfacultatif
Restreint les résultats à un client. Quand votre clé est limitée à des clients spécifiques, les résultats sont toujours pré-filtrés sur ces clients même si ceci est omis.
platformstringfacultatif
Restreint les résultats à une seule plateforme, par ex. facebook, google.
credentialsValidbooleanfacultatif
Restreint aux comptes dont les identifiants stockés sont (true) ou ne sont pas (false) actuellement valides.
fetchStatusstringfacultatif
Restreint aux comptes ayant ce statut de récupération.
cursorstringfacultatif
Curseur de pagination provenant du nextCursor d'une réponse précédente.
limitintegerfacultatif
Nombre maximal de comptes à renvoyer, de 1 à 100. Par défaut 20.
Réponse
dataobjectfacultatif
accountsarray of objectfacultatif
Les comptes connectés correspondants.
idstringfacultatif
Identifiant unique du compte connecté.
platformstringfacultatif
La plateforme à laquelle ce compte se connecte, par ex. google, facebook, instagram.
displayNamestringfacultatif
Nom d'affichage du compte connecté.
providerAccountIdstringfacultatif
L'identifiant propre à la plateforme pour ce compte.
credentialsValidbooleanfacultatif
Si les identifiants stockés sont actuellement valides.
fetchStatusstringfacultatif
Statut de récupération actuel pour ce compte, par ex. idle, fetching.
fetchErrorstringfacultatif
Le dernier message d'erreur de récupération, ou null.
errorTagstringfacultatif
Un code d'erreur court lisible par une machine, ou null.
gmbGroupIdsarray of stringfacultatif
Ids de groupe Google Business Profile associés à ce compte, le cas échéant.
expiresAtstringfacultatif
Date d'expiration du jeton d'accès de ce compte, au format horodatage ISO 8601, ou null.
dataAccessExpiresAtstringfacultatif
Date d'expiration de la fenêtre d'accès aux données de Meta pour ce compte, au format horodatage ISO 8601, ou null.
channelstringfacultatif
Le canal par lequel cette connexion a été établie.
clientIdstringfacultatif
ID du client auquel appartient ce compte, ou null pour une connexion valable pour toute l'agence.
synupLocationIdstringfacultatif
Identifiant d'établissement legacy. Déprécié — préférez clientLocationId.
clientLocationIdstringfacultatif
ID de l'établissement auquel ce compte est lié, ou null. Préférez ceci à synupLocationId.
fetchedListingsCountnumberfacultatif
Nombre de fiches récupérées par ce compte.
lastFetchedAtstringfacultatif
Date de dernière récupération complétée par ce compte, au format horodatage ISO 8601, ou null.
connectionStatusstring (CONNECTED | MISSING | RENEW | DISCONNECTED | SUSPENDED | SUGGESTED_MATCH)facultatif
État de santé global de cette connexion : CONNECTED, MISSING, RENEW, DISCONNECTED, SUSPENDED ou SUGGESTED_MATCH.
createdAtstringfacultatif
Date de connexion de ce compte, au format horodatage ISO 8601.
updatedAtstringfacultatif
Date de dernière mise à jour de ce compte, au format horodatage ISO 8601.
nextCursorstringfacultatif
Curseur de pagination pour la page suivante, ou null quand il n'y a plus de résultats.
totalCountnumberfacultatif
Nombre total de comptes correspondant à la requête.
Erreurs
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/connections
Votre clé 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
  }
}