v1Recursos/Clients/getObtener un cliente

Obtener un cliente

Devuelve todos los detalles de un cliente: perfil de negocio, representante asignado, creador, puntuación de salud y plan.

get/api/v1/clients/{id}

clients:read

Parámetros de consulta

idstringobligatorio

El cliente a consultar.

Respuesta

dataobjectopcional

Todo lo de Client, además de los objetos resueltos de representante, creador y plan.

Errores

401La clave de API falta, es inválida, expiró o fue revocada.

403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.

404El recurso no se encontró, o no pertenece a su agencia.

429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.

get/api/v1/clients/{id}

Su clave de API

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
  }
}