/api/v4/connected-accounts/connected-account-listingsRécupérer les fiches d’un compte connecté
Renvoie les fiches Google Business Profile ou Facebook accessibles à un compte connecté, avec filtrage et pagination facultatifs.
Paramètres
Corps
| Nom | Type | Obligatoire | Description |
|---|---|---|---|
| connectedAccountId | string | obligatoire | UUID of the connected account whose listings to fetch. Send this in the JSON body: as a query parameter it is ignored. |
| page | integer | facultatif | Page number to fetch. Defaults to 1. |
| perPage | integer | facultatif | Records per page. Defaults to 500, which is also the maximum. |
| locationInfo | string | facultatif | Free-text search within the account's listings. Matches business name, address lines, locality, postal code, store code, and phone. |
Exemple de requête
Corps prêt à coller. Remplacez les identifiants et valeurs d’exemple par les vôtres.
{ "connectedAccountId": "4f712c17-4f95-42dd-90f4-97171a2e67b5", "perPage": 50}Réponses
200List of listings accessible to the account, with pagination metadata.
{ "data": { "connectedAccountListings": { "pageInfo": { "hasNextPage": false, "hasPreviousPage": false, "totalPages": 1, "totalRecords": 60 }, "records": [ { "accountTypeName": "Google", "address": "123 William St, NY 10038, Manhattan, US", "id": "R21iQnVsa0RhdGFMYWtlOjA2MDQ4NmExLTA0NzQtNDc4NS1iMjNhLTBkOGM4MzhmNGQ5OA==", "liveLink": null, "locationName": "Trial", "phone": "(718) 667-7787" } ] } }}401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.
Renvoie les fiches Google Business Profile ou Facebook auxquelles un compte connecté a accès. Chaque enregistrement comprend le id de la fiche (un identifiant en base64), locationName, address, phone et liveLink. Bien qu’il s’agisse d’un POST, cette opération est une lecture, mais les options de compte et de pagination doivent être envoyées dans le corps JSON.
Cas d’utilisation : créer un sélecteur de fiches. Après qu’un client a connecté un compte Google possédant des dizaines de fiches, appelez cet endpoint pour afficher une liste dans laquelle il peut effectuer une recherche. Placez un terme de recherche saisi par le client dans locationInfo (la recherche porte sur le nom, l’adresse, le téléphone, le code postal et le code du magasin) afin qu’il puisse trouver rapidement le bon point de vente.
Cas d’utilisation : fournir les données à connect-listing. Le id de chaque enregistrement correspond exactement au connectedAccountListingId attendu par connect-listing. Récupérez les fiches, laissez le client (ou votre logique de correspondance) en choisir une, puis transmettez son id ainsi que le locationId cible dans Listings API à connect-listing pour les associer.
Utilisez les clés page et perPage directement à la racine du corps pour la pagination ; perPage vaut 500 par défaut, ce qui est également le maximum. Lisez pageInfo.hasNextPage et pageInfo.totalPages dans la réponse pour parcourir l’ensemble des résultats page par page. Cet endpoint est pris en compte dans la limite de débit du compte ; une réponse 429 inclut un en-tête Retry-After.
La structure de la requête ci-dessus a été vérifiée auprès de l’API en production. L’exemple de réponse est fourni à titre illustratif.
curl -X POST 'https://listingsapi.com/api/v4/connected-accounts/connected-account-listings' \ -H "Authorization: API $LISTINGSAPI_KEY" \ -H 'Content-Type: application/json' \ -d '{ "connectedAccountId": "4f712c17-4f95-42dd-90f4-97171a2e67b5", "perPage": 50 }'