Synupv1
Créer une clé
v1Ressources/Locations/getLister / rechercher des établissements

Lister / rechercher des établissements

Renvoie une page d'établissements, les plus récents en premier. Tous les filtres sont facultatifs et se combinent (un établissement doit correspondre à tous) ; pour parcourir plus de résultats, renvoyez le nextCursor reçu.

get/api/v1/locations
locations:read
Paramètres de requête
clientIdstringfacultatif
Restreint les résultats à un client. Si votre clé est limitée à des clients spécifiques, celui-ci doit en faire partie. Retrouvez-le avec GET /api/v1/clients.
searchstringfacultatif
Recherche libre sur le nom, l'adresse postale, la ville ou le téléphone de l'établissement (insensible à la casse, correspondances partielles autorisées).
statusstring (all | active | archived | archival_pending | verification_pending | unapproved | requires_action)facultatif
Une seule catégorie de statut : all, active (non archivé), archived, archival_pending, verification_pending (approbation Google en attente), unapproved ou requires_action. La valeur par défaut est all.
tagsarray of stringfacultatif
Étiquettes internes — correspond à un établissement possédant au moins une d'entre elles.
categoriesarray of stringfacultatif
Noms d'affichage de catégories — correspond à un établissement dont la catégorie générale ou Google est l'une d'elles.
verificationarray of string (verified | pending | unverified | unknown)facultatif
État de vérification Google : verified, pending, unverified ou unknown.
createdAfterstringfacultatif
Uniquement les établissements créés à cette date ou après.
createdBeforestringfacultatif
Uniquement les établissements créés à cette date ou avant.
cursorstringfacultatif
Curseur de pagination provenant du nextCursor d'une réponse précédente. Laisser vide pour la première page.
limitintegerfacultatif
Nombre d'établissements à renvoyer par page, 1–200. La valeur par défaut est 50.
Réponse
dataobjectfacultatif
locationsarray of objectfacultatif
Les établissements correspondants pour cette page.
idstringfacultatif
Identifiant unique de l'établissement.
namestringfacultatif
Le nom commercial de l'établissement.
addressstringfacultatif
L'adresse postale de l'établissement (lignes de rue combinées), ou null.
citystringfacultatif
Ville.
statestringfacultatif
État ou région.
postalCodestringfacultatif
Code postal, ou null.
countrystringfacultatif
Pays, au format code ISO-3166-1 alpha-2, ou null.
phonestringfacultatif
Numéro de téléphone principal, ou null.
websitestringfacultatif
L'URL du site web de l'établissement, ou null.
storeCodestringfacultatif
Votre code de magasin / référence interne pour cet établissement, ou null.
categorystringfacultatif
La catégorie d'affichage de l'établissement (catégorie principale par publisher si définie, sinon la catégorie générale), ou null.
tagsarray of stringfacultatif
Étiquettes internes pour votre propre organisation — non affichées publiquement.
labelsarray of stringfacultatif
Libellés internes pour cet établissement.
statusstring (active | archived | archival_pending | verification_pending | unapproved | requires_action)facultatif
Statut dérivé : active, archived, archival_pending, verification_pending (approbation Google en attente), unapproved ou requires_action.
verificationStatusstring (verified | pending | unverified | unknown)facultatif
État de vérification Google : verified, pending, unverified ou unknown, ou null.
pendingChangesnumberfacultatif
Nombre de modifications enregistrées mises en file d'attente pour publication mais pas encore synchronisées avec les annuaires connectés.
lastPublishedAtstringfacultatif
Date de la dernière synchronisation réussie des informations de cet établissement vers un publisher, au format horodatage ISO 8601, ou null.
clientIdstringfacultatif
ID du client auquel appartient cet établissement, ou null.
clientNamestringfacultatif
Nom commercial du client auquel appartient cet établissement, ou null.
createdAtstringfacultatif
Date de création de l'établissement, au format horodatage ISO 8601.
nextCursorstringfacultatif
Curseur de pagination pour la page suivante, ou null lorsqu'il n'y a plus de résultats.
totalnumberfacultatif
Nombre total d'établissements correspondant aux filtres, sur toutes les pages.
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/locations
Votre clé API
clientId
search
status
tags
categories
verification
createdAfter
createdBefore
cursor
limit
{
  "data": [
    {
      "id": "loc_456",
      "name": "Acme Dental — Downtown",
      "city": "Austin",
      "state": "TX",
      "clientId": "cli_123",
      "createdAt": "2026-01-15T10:05:00.000Z"
    }
  ]
}