v1Ressourcen/Clients/getClient abrufen

Client abrufen

Liefert vollständige Details zu einem Kunden: Unternehmensprofil, zugewiesener Ansprechpartner, Ersteller, Gesundheitswert und Plan.

get/api/v1/clients/{id}

clients:read

Query-Parameter

idstringerforderlich

Der abzurufende Kunde.

Antwort

dataobjectoptional

Alles aus Client, plus die aufgelösten Objekte für Ansprechpartner, Ersteller und Plan.

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.

404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.

429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.

get/api/v1/clients/{id}

Ihr API-Schlüssel

id *

{
  "data": {
    "id": "cli_123",
    "businessName": "Acme Dental",
    "website": "https://acmedental.com",
    "industry": "Dental",
    "primaryContactEmail": "owner@acmedental.com",
    "primaryRepresentativeId": "usr_123",
    "visibility": "public",
    "goal": "get_reviews",
    "notes": null,
    "gbpLink": null,
    "trackingKeyword": "dentist near me",
    "healthScore": 82,
    "planName": null,
    "archived": false,
    "archivedAt": null,
    "scheduledArchiveAt": null,
    "createdAt": "2026-01-15T10:00:00.000Z",
    "updatedAt": "2026-01-15T10:00:00.000Z",
    "primaryRepresentative": {
      "id": "usr_123",
      "firstName": "Jamie",
      "lastName": "Lee",
      "email": "jamie@youragency.com"
    },
    "createdBy": {
      "id": "usr_123",
      "firstName": "Jamie",
      "lastName": "Lee",
      "email": "jamie@youragency.com"
    },
    "clientPlan": null
  }
}