GET

/v1/patients

Listar pacientes

Permissão:patients:read

Autenticação

Envie o token de acesso do usuário no cabeçalho Authorization e, se ele tiver mais de uma clínica, o X-Clinic-Id. Integrações servidor a servidor usam o token de serviço com X-Clinic-Id e X-Agent-Key. Como autenticar

1Authorization: Bearer <TOKEN>2X-Clinic-Id: <clinic_id>

Parâmetros

Parâmetros de consulta

Parâmetros de consulta
Parâmetro	Tipo	Obrigatório	Descrição
`limit`	integer	Não	Itens por página (1–100). · Padrão: `25` · Entre 1 e 100
`cursor`	string	Não	Cursor opaco recebido em meta.nextCursor. · Até 200 caracteres
`page`	integer	Não	Paginação numerada (tabelas): página 1-based, offset = (page − 1) × limit. Ignorado quando há `cursor`. Listas longas/feeds devem usar `cursor`. · Entre 1 e 200
`sort`	string	Não	Ordenação: campos separados por vírgula, prefixo "-" = decrescente. Permitidos: name, lastVisitAt, createdAt, nextAppointmentAt. Padrão: name. · Até 120 caracteres
`q`	string	Não	Nome, telefone, e-mail ou tag. · Até 100 caracteres
`status`	string	Não	Valores: `ativo`, `inativo`
`isNew`	boolean	Não	—
`tag`	string	Não	Até 40 caracteres
`service`	string	Não	service_keys separados por vírgula.
`professional`	string	Não	professional_keys separados por vírgula.
`origin`	string	Não	Até 64 caracteres
`plan`	string	Não	Valores: `Particular`, `Convênio`
`hasNextAppointment`	boolean	Não	—
`noVisitSinceDays`	integer	Não	Sem consulta há N dias ou mais (reativação). · Entre 1 e 3650
`lastVisit`	string	Não	Filtro "Última sessão": 30 = até 30 dias; 90 = de 31 a 90 dias; mais = há mais de 90 dias; nunca = sem sessão realizada. · Valores: `todos`, `30`, `90`, `mais`, `nunca`
`createdFrom`	string	Não	Formato `AAAA-MM-DD`
`createdTo`	string	Não	Formato `AAAA-MM-DD`

limitintegerOpcional
Itens por página (1–100). · Padrão: 25 · Entre 1 e 100
cursorstringOpcional
Cursor opaco recebido em meta.nextCursor. · Até 200 caracteres
pageintegerOpcional
Paginação numerada (tabelas): página 1-based, offset = (page − 1) × limit. Ignorado quando há cursor. Listas longas/feeds devem usar cursor. · Entre 1 e 200
sortstringOpcional
Ordenação: campos separados por vírgula, prefixo "-" = decrescente. Permitidos: name, lastVisitAt, createdAt, nextAppointmentAt. Padrão: name. · Até 120 caracteres
qstringOpcional
Nome, telefone, e-mail ou tag. · Até 100 caracteres
statusstringOpcional
Valores: ativo, inativo
isNewbooleanOpcional
tagstringOpcional
Até 40 caracteres
servicestringOpcional
service_keys separados por vírgula.
professionalstringOpcional
professional_keys separados por vírgula.
originstringOpcional
Até 64 caracteres
planstringOpcional
Valores: Particular, Convênio
hasNextAppointmentbooleanOpcional
noVisitSinceDaysintegerOpcional
Sem consulta há N dias ou mais (reativação). · Entre 1 e 3650
lastVisitstringOpcional
Filtro "Última sessão": 30 = até 30 dias; 90 = de 31 a 90 dias; mais = há mais de 90 dias; nunca = sem sessão realizada. · Valores: todos, 30, 90, mais, nunca
createdFromstringOpcional
Formato AAAA-MM-DD
createdTostringOpcional
Formato AAAA-MM-DD

Cabeçalhos

Cabeçalhos
Parâmetro	Tipo	Obrigatório	Descrição
`X-Clinic-Id`	string	Não	Clínica ativa. Obrigatório só para quem tem acesso a mais de uma clínica (ou token de serviço). Validado contra o vínculo do usuário. · Padrão (regex): `^[A-Za-z0-9._-]{1,64}$`

X-Clinic-IdstringOpcional
Clínica ativa. Obrigatório só para quem tem acesso a mais de uma clínica (ou token de serviço). Validado contra o vínculo do usuário. · Padrão (regex): ^[A-Za-z0-9._-]{1,64}$

Exemplo de requisição

Gerado do contrato. Troque os marcadores entre < > pelos seus valores.

1const res = await fetch("https://myclinc.leadpoint.com.br/v1/patients?limit=25", {2  method: "GET",3  headers: {4    Authorization: "Bearer <TOKEN>",5    "X-Clinic-Id": "<clinic_id>",6  },7})89if (!res.ok) {10  const { error } = await res.json()11  throw new Error(`${error.code}: ${error.message} (${error.requestId})`)12}13const { data } = await res.json()

Resposta

200OK — Sucesso.

JSON

1{2  "data": [3    {4      "id": "<id>",5      "name": "<name>",6      "age": 1,7      "sex": "Feminino",8      "birthDate": "2026-09-18",9      "cpf": "<cpf>",10      "phone": "<phone>",11      "email": "<email>",12      "city": "<city>",13      "address": "<address>",14      "status": "ativo",15      "isNew": true,16      "tags": [17        "<tag>"18      ],19      "service": {20        "key": "<key>",21        "name": "<name>"22      },23      "plan": "Particular",24      "origin": "Lead (Instagram)",25      "professional": {26        "key": "<key>",27        "name": "<name>"28      },29      "lastVisitAt": "2026-09-18T14:00:00.000Z",30      "lastVisitDaysAgo": 1,31      "nextAppointment": {32        "id": "<id>",33        "date": "2026-09-18",34        "time": "<time>",35        "professional": "<professional>",36        "type": "<type>"37      },38      "leadId": "<leadId>",39      "lgpdConsentAt": "2026-09-18T14:00:00.000Z",40      "createdAt": "2026-09-18T14:00:00.000Z",41      "updatedAt": "2026-09-18T14:00:00.000Z"42    }43  ],44  "meta": {45    "hasNext": true,46    "nextCursor": "<nextCursor>",47    "total": 1,48    "limit": 149  }50}

Exemplo gerado do esquema da resposta; valores entre < > são ilustrativos.

Códigos de erro

Corpo no formato padrão { error: { code, message, requestId } }. Veja todos os códigos.

400

Bad Request — Requisição malformada (JSON inválido, cursor inválido ou clínica ativa não informada).

401

Unauthorized — Token ausente, inválido ou expirado.

403

Forbidden — Autenticado, mas sem permissão (perfil ou clínica).

422

Unprocessable Entity — Dados semanticamente inválidos (erros por campo em details).

429

Too Many Requests — Limite de requisições excedido (veja Retry-After).

500

Internal Server Error — Erro interno (sem detalhes expostos).

503

Service Unavailable — Banco de dados indisponível ou não configurado.

Limites

Limite padrão: 120 requisições a cada 60 segundos por token. Sobre limites

Testar no Swagger