Synupv1
Créer une clé
v1Ressources/Clients/getLister / rechercher des clients

Lister / rechercher des clients

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

get/api/v1/clients
clients:read
Paramètres de requête
searchstringfacultatif
Recherche libre sur le nom commercial, le secteur ou l'e-mail du contact principal du client (insensible à la casse, correspondances partielles autorisées).
statusarray of string (complete | draft)facultatif
Restreindre à un ou plusieurs statuts : complete (actif, intégration terminée) ou draft (encore en configuration).
representativeIdsarray of stringfacultatif
Restreindre aux clients assignés à un ou plusieurs de ces identifiants de membres d'équipe — voir GET /api/v1/team/members pour les identifiants de membres de votre agence.
goalsarray of string (improve_rankings | get_reviews | fix_listings)facultatif
Restreindre à un ou plusieurs objectifs principaux du client : improve_rankings, get_reviews ou fix_listings.
healthMinnumberfacultatif
Score de santé minimum à inclure, 0–100.
healthMaxnumberfacultatif
Score de santé maximum à inclure, 0–100.
locationsMinnumberfacultatif
Nombre minimum d'établissements qu'un client doit avoir pour être inclus.
locationsMaxnumberfacultatif
Nombre maximum d'établissements qu'un client peut avoir tout en étant inclus.
createdAfterstringfacultatif
Uniquement les clients créés à cette date ou après.
createdBeforestringfacultatif
Uniquement les clients 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 de clients à renvoyer par page, 1–200. La valeur par défaut est 50.
Réponse
dataobjectfacultatif
clientsarray of objectfacultatif
Les clients correspondant à cette page.
idstringfacultatif
Identifiant unique du client.
businessNamestringfacultatif
Le nom commercial du client.
industrystringfacultatif
Le secteur d'activité du client.
statusstring (complete | draft)facultatif
Statut d'intégration : complete (actif) ou draft.
goalstring (improve_rankings | get_reviews | fix_listings)facultatif
L'objectif principal du client, ou null.
healthScorenumberfacultatif
Un score de 0 à 100 résumant la santé du compte du client, ou null si non encore calculé.
locationCountnumberfacultatif
Nombre d'établissements de ce client, ou null si inconnu.
googleRatingnumberfacultatif
La note Google actuelle du client, ou null.
googleReviewCountnumberfacultatif
Le nombre actuel d'avis Google du client, ou null.
planNamestringfacultatif
Nom du plan de ce client, le cas échéant.
createdAtstringfacultatif
Date de création du client, au format horodatage ISO 8601.
archivedbooleanfacultatif
Si le client est archivé.
archivedAtstringfacultatif
Date d'archivage du client, au format horodatage ISO 8601, ou null.
scheduledArchiveAtstringfacultatif
Date à laquelle l'archivage a été demandé (aussi le jeton de cohorte pour l'annuler), au format horodatage ISO 8601, ou null si aucun n'est en attente.
primaryRepresentativeobjectfacultatif
Le membre de l'équipe responsable de ce client, ou null.
idstringfacultatif
firstNamestringfacultatif
lastNamestringfacultatif
emailstringfacultatif
nextCursorstringfacultatif
Curseur de pagination pour la page suivante, ou null lorsqu'il n'y a plus de résultats.
totalnumberfacultatif
Nombre total de clients 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/clients
Votre clé API
search
status
representativeIds
goals
healthMin
healthMax
locationsMin
locationsMax
createdAfter
createdBefore
cursor
limit
{
  "data": {
    "clients": [
      {
        "id": "cli_123",
        "businessName": "Acme Dental",
        "industry": "Dental",
        "status": "complete",
        "goal": "get_reviews",
        "healthScore": 82,
        "locationCount": 1,
        "googleRating": 4.8,
        "googleReviewCount": 26,
        "archived": false,
        "archivedAt": null,
        "scheduledArchiveAt": null,
        "packageType": null,
        "planName": null,
        "createdAt": "2026-01-15T10:00:00.000Z",
        "primaryRepresentative": {
          "id": "usr_123",
          "firstName": "Jamie",
          "lastName": "Lee",
          "email": "jamie@youragency.com"
        }
      }
    ],
    "nextCursor": null,
    "total": 1
  }
}