/api/v4/connected-accountsLister les comptes connectés
Renvoie les comptes Google et Facebook connectés à votre compte Listings API, avec l’état des connexions et le nombre d’établissements associés.
Paramètres
Chaîne de requête
| Nom | Type | Obligatoire | Description | Par défaut |
|---|---|---|---|---|
| page | integer | facultatif | 1-based page number. | 1 |
| perPage | integer | facultatif | Records per page. | 20 |
| publisher | string | facultatif | Narrow to one publisher by account type: `GoogleAccount`, `FacebookAccount`, `AppleAccount`, `YelpAccount`, `TripadvisorAccount`, `LinkedinAccount`, `PinterestAccount`, or `TwitterAccount`. | — |
| status | string | facultatif | 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. | — |
Réponses
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.
Renvoie tous les comptes Google Business Profile et Facebook Pages autorisés à se connecter à votre compte Listings API. Chaque enregistrement contient l’état de la connexion (status, connectivityIssue), le nombre d’établissements associés (connectedLocationsCount) et l’état de la dernière récupération des correspondances (requestMatchesStatus).
Cas d’utilisation : vérifier l’état des connexions avant une synchronisation. Exécutez cette opération au début d’une tâche nocturne pour repérer les comptes dont les identifiants ont expiré. Tout enregistrement dont connectivityIssue n’est pas null ou dont status est différent de CONNECTED nécessite que le client renouvelle son autorisation via le parcours de connexion ; ignorez ces enregistrements pour ne pas gaspiller un appel trigger-matches avec des identifiants invalides.
Cas d’utilisation : déterminer la valeur de connectedAccountId pour les appels suivants. Les endpoints trigger-matches, fetch-listings, folders et details utilisent tous connectedAccountId comme clé. Listez les comptes, choisissez celui dont email correspond au client et réutilisez son connectedAccountId.
La pagination et le filtrage utilisent des paramètres de requête simples et non imbriqués, et non du JSON : page, perPage, publisher et status. Il n’existe aucun paramètre pageInfo, filters ou sort, ni aucun moyen de modifier l’ordre : les résultats sont toujours triés par adresse e-mail du compte, par ordre croissant. Tout autre élément envoyé est ignoré plutôt que rejeté ; ainsi, un pageInfo en JSON renvoie la page 1 sans avertissement.
curl -s 'https://listingsapi.com/api/v4/connected-accounts?page=1&perPage=20&publisher=GoogleAccount&status=Connected' \ -H "Authorization: API $LISTINGSAPI_KEY"Le filtre status et le champ status n’utilisent pas le même vocabulaire. Le filtre accepte Connected, NotConnected ou ConnectionIssue ; la valeur de status dans chaque enregistrement renvoyé est CONNECTED, MATCH_IN_PROGRESS ou CONNECTIVITY_ISSUE. Réutiliser la valeur de status d’un enregistrement comme filtre constitue une valeur d’énumération invalide et entraîne le renvoi de 400.
Consultez pageInfo.hasNextPage et pageInfo.totalPages dans la réponse pour déterminer s’il faut récupérer une autre page. Les appels à cet endpoint sont comptabilisés dans la limite de débit du compte ; une réponse 429 inclut un en-tête Retry-After.
curl -X GET 'https://listingsapi.com/api/v4/connected-accounts' \ -H "Authorization: API $LISTINGSAPI_KEY"