Synupv1
Criar chave
v1Recursos/Clients/getListar / buscar clientes

Listar / buscar clientes

Retorna uma página dos clientes da sua agência, os mais recentes primeiro. Todos os filtros são opcionais e se combinam (um cliente precisa corresponder a todos); para avançar para mais resultados, envie novamente o nextCursor retornado.

get/api/v1/clients
clients:read
Parâmetros de consulta
searchstringopcional
Busca por texto livre no nome comercial, setor ou e-mail do contato principal do cliente (sem diferenciar maiúsculas/minúsculas, correspondências parciais permitidas).
statusarray of string (complete | draft)opcional
Restringir a um ou mais status: complete (ativo, integração concluída) ou draft (ainda em configuração).
representativeIdsarray of stringopcional
Restringir a clientes atribuídos a um ou mais destes IDs de membros da equipe — consulte GET /api/v1/team/members para os IDs de membros da sua agência.
goalsarray of string (improve_rankings | get_reviews | fix_listings)opcional
Restringir a um ou mais objetivos principais do cliente: improve_rankings, get_reviews ou fix_listings.
healthMinnumberopcional
Menor pontuação de saúde a incluir, 0–100.
healthMaxnumberopcional
Maior pontuação de saúde a incluir, 0–100.
locationsMinnumberopcional
Número mínimo de locais que um cliente precisa ter para ser incluído.
locationsMaxnumberopcional
Número máximo de locais que um cliente pode ter e ainda ser incluído.
createdAfterstringopcional
Somente clientes criados nesta data ou depois.
createdBeforestringopcional
Somente clientes criados nesta data ou antes.
cursorstringopcional
Cursor de paginação do nextCursor de uma resposta anterior. Deixe vazio para a primeira página.
limitintegeropcional
Clientes a retornar por página, 1–200. O padrão é 50.
Resposta
dataobjectopcional
clientsarray of objectopcional
Os clientes que correspondem a esta página.
idstringopcional
Identificador único do cliente.
businessNamestringopcional
O nome comercial do cliente.
industrystringopcional
O setor de atuação do cliente.
statusstring (complete | draft)opcional
Status de integração: complete (ativo) ou draft.
goalstring (improve_rankings | get_reviews | fix_listings)opcional
O objetivo principal do cliente, ou null.
healthScorenumberopcional
Uma pontuação de 0 a 100 que resume a saúde da conta do cliente, ou null se ainda não calculada.
locationCountnumberopcional
Número de locais deste cliente, ou null se desconhecido.
googleRatingnumberopcional
A avaliação atual em estrelas do Google do cliente, ou null.
googleReviewCountnumberopcional
O número atual de avaliações do Google do cliente, ou null.
planNamestringopcional
Nome do plano deste cliente, se houver.
createdAtstringopcional
Data de criação do cliente, como timestamp ISO 8601.
archivedbooleanopcional
Se o cliente está arquivado.
archivedAtstringopcional
Data em que o cliente foi arquivado, como timestamp ISO 8601, ou null.
scheduledArchiveAtstringopcional
Data em que o arquivamento foi solicitado (também o token de coorte para cancelá-lo), como timestamp ISO 8601, ou null se nenhum estiver pendente.
primaryRepresentativeobjectopcional
O membro da equipe responsável por este cliente, ou null.
idstringopcional
firstNamestringopcional
lastNamestringopcional
emailstringopcional
nextCursorstringopcional
Cursor de paginação para a próxima página, ou null quando não há mais resultados.
totalnumberopcional
Número total de clientes que correspondem aos filtros, em todas as páginas.
Erros
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
get/api/v1/clients
Sua chave 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
  }
}