Synupv1
Crear clave
v1Recursos/Clients/getListar / buscar clientes

Listar / buscar clientes

Devuelve una página de los clientes de su agencia, empezando por los más recientes. Todos los filtros son opcionales y se combinan (un cliente debe cumplir con todos ellos); para avanzar a más resultados, vuelva a enviar el nextCursor devuelto.

get/api/v1/clients
clients:read
Parámetros de consulta
searchstringopcional
Búsqueda de texto libre sobre el nombre comercial, el sector o el correo del contacto principal del cliente (sin distinguir mayúsculas, coincidencias parciales permitidas).
statusarray of string (complete | draft)opcional
Restringir a uno o más estados: complete (activo, totalmente incorporado) o draft (aún en configuración).
representativeIdsarray of stringopcional
Restringir a clientes asignados a uno o más de estos ID de miembros del equipo — consulte GET /api/v1/team/members para los ID de miembros de su agencia.
goalsarray of string (improve_rankings | get_reviews | fix_listings)opcional
Restringir a uno o más objetivos principales del cliente: improve_rankings, get_reviews o fix_listings.
healthMinnumberopcional
Puntuación de salud mínima a incluir, 0–100.
healthMaxnumberopcional
Puntuación de salud máxima a incluir, 0–100.
locationsMinnumberopcional
Número mínimo de ubicaciones que debe tener un cliente para incluirse.
locationsMaxnumberopcional
Número máximo de ubicaciones que puede tener un cliente y seguir incluyéndose.
createdAfterstringopcional
Solo clientes creados en esta fecha o después.
createdBeforestringopcional
Solo clientes creados en esta fecha o antes.
cursorstringopcional
Cursor de paginación del nextCursor de una respuesta anterior. Déjelo vacío para la primera página.
limitintegeropcional
Clientes a devolver por página, 1–200. El valor por defecto es 50.
Respuesta
dataobjectopcional
clientsarray of objectopcional
Los clientes que coinciden con esta página.
idstringopcional
Identificador único del cliente.
businessNamestringopcional
El nombre comercial del cliente.
industrystringopcional
El sector del cliente.
statusstring (complete | draft)opcional
Estado de incorporación: complete (activo) o draft.
goalstring (improve_rankings | get_reviews | fix_listings)opcional
El objetivo principal del cliente, o null.
healthScorenumberopcional
Una puntuación de 0 a 100 que resume la salud de la cuenta del cliente, o null si aún no se ha calculado.
locationCountnumberopcional
Número de ubicaciones que tiene este cliente, o null si se desconoce.
googleRatingnumberopcional
La calificación actual en estrellas de Google del cliente, o null.
googleReviewCountnumberopcional
El número actual de reseñas de Google del cliente, o null.
planNamestringopcional
Nombre del plan de este cliente, si tiene uno.
createdAtstringopcional
Fecha de creación del cliente, como marca de tiempo ISO 8601.
archivedbooleanopcional
Si el cliente está archivado.
archivedAtstringopcional
Fecha en que se archivó el cliente, como marca de tiempo ISO 8601, o null.
scheduledArchiveAtstringopcional
Fecha en que se solicitó el archivado (también el token de cohorte para cancelarlo), como marca de tiempo ISO 8601, o null si no hay ninguno pendiente.
primaryRepresentativeobjectopcional
El miembro del equipo responsable de este cliente, o null.
idstringopcional
firstNamestringopcional
lastNamestringopcional
emailstringopcional
nextCursorstringopcional
Cursor de paginación para la siguiente página, o null cuando no hay más resultados.
totalnumberopcional
Número total de clientes que coinciden con los filtros, en todas las páginas.
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.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/clients
Su clave de 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
  }
}