Listar contatos

GET/api/v1/contacts

Lista paginada de contatos ativos (soft-deletados ficam de fora). O lookup por phone é o jeito certo de achar um contato a partir de uma mensagem de WhatsApp.

Parâmetros de query

limit
number
Itens por página, inteiro entre 1 e 100.
default: 20
cursor
string
Cursor opaco de paginação · passe o nextCursor da resposta anterior. Omita na primeira página.
email
string
Lookup por email exato (comparação em minúsculas).
q
string
Busca por nome · case-insensitive, casa por trecho.
phone
string
Lookup por telefone · só os dígitos contam (mínimo 8, senão 422), match por substring: ?phone=11999999999 acha "+5511999999999".
since
string (ISO 8601)
Só itens criados a partir desta data (createdAt >=, inclusive). Ex.: 2026-01-01T00:00:00Z.
until
string (ISO 8601)
Só itens criados antes desta data (createdAt <, exclusive).

Autenticação: header Authorization: Bearer rmk_... · veja Introdução e autenticação.

curl "https://crmdojordao.com.br/api/v1/contacts" \
  -H "Authorization: Bearer rmk_SUA_CHAVE"
Resposta · GET /api/v1/contacts
{
  "data": [
    {
      "id": "ct_joao",
      "name": "João Silva",
      "email": "joao@empresaexemplo.com.br",
      "phone": "+5511999999999",
      "title": "Diretor Comercial",
      "accountId": "acc_empresa_exemplo",
      "customFields": {
        "fonte_lead": "Site"
      },
      "createdAt": "2026-07-01T13:30:00.000Z",
      "updatedAt": "2026-07-01T13:30:00.000Z"
    }
  ],
  "nextCursor": "eyJpZCI6ImN0X2pvYW8iLCJjcmVhdGVkQXQiOiIuLi4ifQ",
  "hasMore": false
}