Synupv1
Schlüssel erstellen
v1Ressourcen/Clients/getClients auflisten / suchen

Clients auflisten / suchen

Liefert eine Seite der Kunden Ihrer Agentur, zuletzt erstellte zuerst. Alle Filter sind optional und werden kombiniert (ein Kunde muss allen entsprechen); um weitere Ergebnisse zu blättern, geben Sie den zurückgegebenen nextCursor erneut mit.

get/api/v1/clients
clients:read
Query-Parameter
searchstringoptional
Freitextsuche über Firmenname, Branche oder primäre Kontakt-E-Mail des Kunden (Groß-/Kleinschreibung wird ignoriert, Teiltreffer erlaubt).
statusarray of string (complete | draft)optional
Auf einen oder mehrere Status einschränken: complete (aktiv, vollständig onboardet) oder draft (noch in Einrichtung).
representativeIdsarray of stringoptional
Auf Kunden einschränken, die einer oder mehreren dieser Teammitglieds-IDs zugewiesen sind — siehe GET /api/v1/team/members für die Mitglieds-IDs Ihrer Agentur.
goalsarray of string (improve_rankings | get_reviews | fix_listings)optional
Auf ein oder mehrere primäre Ziele des Kunden einschränken: improve_rankings, get_reviews oder fix_listings.
healthMinnumberoptional
Niedrigster einzuschließender Gesundheitswert, 0–100.
healthMaxnumberoptional
Höchster einzuschließender Gesundheitswert, 0–100.
locationsMinnumberoptional
Mindestanzahl an Standorten, die ein Kunde haben muss, um eingeschlossen zu werden.
locationsMaxnumberoptional
Höchstanzahl an Standorten, die ein Kunde haben darf und trotzdem eingeschlossen wird.
createdAfterstringoptional
Nur Kunden, die an oder nach diesem Datum erstellt wurden.
createdBeforestringoptional
Nur Kunden, die an oder vor diesem Datum erstellt wurden.
cursorstringoptional
Paginierungs-Cursor aus dem nextCursor einer vorherigen Antwort. Für die erste Seite leer lassen.
limitintegeroptional
Kunden pro Seite, 1–200. Standardmäßig 50.
Antwort
dataobjectoptional
clientsarray of objectoptional
Die zu dieser Seite passenden Kunden.
idstringoptional
Eindeutige Kennung des Kunden.
businessNamestringoptional
Der Firmenname des Kunden.
industrystringoptional
Die Branche des Kunden.
statusstring (complete | draft)optional
Onboarding-Status: complete (aktiv) oder draft.
goalstring (improve_rankings | get_reviews | fix_listings)optional
Das primäre Ziel des Kunden, oder null.
healthScorenumberoptional
Ein Wert von 0–100, der den Kontostatus des Kunden zusammenfasst, oder null, falls noch nicht berechnet.
locationCountnumberoptional
Anzahl der Standorte dieses Kunden, oder null, falls unbekannt.
googleRatingnumberoptional
Die aktuelle Google-Sternebewertung des Kunden, oder null.
googleReviewCountnumberoptional
Die aktuelle Anzahl der Google-Bewertungen des Kunden, oder null.
planNamestringoptional
Name des Plans, auf dem dieser Kunde läuft, falls vorhanden.
createdAtstringoptional
Zeitpunkt der Erstellung des Kunden, als ISO-8601-Zeitstempel.
archivedbooleanoptional
Ob der Kunde archiviert ist.
archivedAtstringoptional
Zeitpunkt der Archivierung des Kunden, als ISO-8601-Zeitstempel, oder null.
scheduledArchiveAtstringoptional
Zeitpunkt, zu dem die Archivierung angefordert wurde (zugleich das Kohorten-Token, um sie abzubrechen), als ISO-8601-Zeitstempel, oder null, wenn keine ausstehend ist.
primaryRepresentativeobjectoptional
Das für diesen Kunden verantwortliche Teammitglied, oder null.
idstringoptional
firstNamestringoptional
lastNamestringoptional
emailstringoptional
nextCursorstringoptional
Paginierungs-Cursor für die nächste Seite, oder null, wenn keine weiteren Ergebnisse vorliegen.
totalnumberoptional
Gesamtzahl der Kunden, die den Filtern entsprechen, über alle Seiten hinweg.
Fehler
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/clients
Ihr API-Schlüssel
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
  }
}