Synup
Créer une clé
v1Ressources/Locations/getLister les groupes d'établissements

Lister les groupes d'établissements

Un groupe d'établissements est un ensemble d'établissements publiés ensemble comme une seule marque. Sur les annuaires qui le permettent (aujourd'hui Localtunity et les sites régionaux qui le reprennent), le groupe est une seule entreprise portant le nom du groupe, et chaque établissement y apparaît avec sa propre adresse. Les autres annuaires continuent de publier chaque établissement séparément. Utilisez-le pour une chaîne, le plus souvent quand ses établissements partagent un numéro de téléphone, car ces annuaires n'acceptent qu'une fiche par numéro. Renvoie chaque groupe visible par la clé, ainsi que `sites` : les annuaires qui publient les groupes ensemble. Avec une clé limitée à certains clients, les nombres et les ids clients ne couvrent que ces clients ; `hiddenLocationCount` compte le reste.

get/api/v1/location-groups
locations:read
Paramètres de requête
locationIdstringfacultatif
Ne renvoyer que le groupe de cet établissement (id ou id public de l'établissement).
Réponse
dataobjectfacultatif
groupsarray of objectfacultatif
idstringfacultatif
namestringfacultatif
Le nom d'entreprise sous lequel les établissements apparaissent sur les annuaires qui publient le groupe.
locationCountintegerfacultatif
Établissements du groupe visibles par la clé.
clientIdsarray of stringfacultatif
Clients de ces établissements.
hiddenLocationCountintegerfacultatif
Établissements du groupe appartenant à des clients auxquels la clé n'a pas accès.
createdAtstringfacultatif
sitesarray of objectfacultatif
Annuaires qui publient les groupes ensemble.
siteIdintegerfacultatif
namestringfacultatif
copiesarray of objectfacultatif
Sites régionaux qui republient les fiches de cet annuaire.
siteIdintegerfacultatif
namestringfacultatif
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
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.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/location-groups
Votre clé API
locationId
{}

Guides qui utilisent cette ressource