Pular para o conteúdo
MyClinicAPI Docs
GET

/v1/conversations

Listar conversas (abas, canal, responsável, busca e ordenação no servidor)

Projeção leve (sem contato/agendamentos — veja GET /conversations/{id}). Use cursor para rolagem infinita.

Permissão:conversations: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

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

Parâmetros

Parâmetros de consulta

  • 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

  • channelstringOpcional

    Canais separados por vírgula: whatsapp, email, sms, instagram, outros.

  • agentstringOpcional

    ia = conduzida por assistente de IA agora; equipe = sem agente ativo. · Valores: ia, equipe

  • qstringOpcional

    Nome ou telefone do contato (mín. 2 caracteres). · Até 100 caracteres

  • patientIdstringOpcional

    Entre 1 e 64 caracteres · Padrão (regex): ^[A-Za-z0-9._-]+$

  • leadIdstringOpcional

    Entre 1 e 64 caracteres · Padrão (regex): ^[A-Za-z0-9._-]+$

  • viewstringOpcional

    all exclui arquivadas. · Valores: all, mine, unread, archived · Padrão: "all"

  • sortstringOpcional

    Campos: lastMessageAt, unread, name (prefixo - = decrescente). Ex.: -unread,-lastMessageAt. · Padrão: "-lastMessageAt" · Até 60 caracteres

Cabeçalhos

  • 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.

const res = await fetch("https://myclinc.leadpoint.com.br/v1/conversations?limit=25", {  method: "GET",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",  },})​if (!res.ok) {  const { error } = await res.json()  throw new Error(`${error.code}: ${error.message} (${error.requestId})`)}const { data } = await res.json()

Resposta

200OK — Sucesso.
JSON
{  "data": [    {      "id": "<id>",      "name": "<name>",      "channel": "whatsapp",      "preview": "<preview>",      "lastMessageAt": "2026-09-18T14:00:00.000Z",      "unread": 1,      "mine": true,      "assignedTo": {        "id": "<id>",        "name": "<name>"      },      "archived": true,      "activeAgent": {        "key": "<key>",        "name": "<name>",        "image": "<image>"      },      "patientId": "<patientId>",      "leadId": "<leadId>",      "tags": [        "<tag>"      ]    }  ],  "meta": {    "hasNext": true,    "nextCursor": "<nextCursor>",    "total": 1,    "limit": 1  }}

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(abre em nova aba)