GET/public/contacts

Listar contatos

Lista os contatos da empresa, do mais novo para o mais antigo.

Chave com permissão de leitura (read)


Cabeçalhos

NomeTipoDescrição
AuthorizationobrigatóriostringBearer pk_sua_chave — a chave de API criada em Configurações › API Keys.

Parâmetros de consulta (query)

NomeTipoDescrição
searchstringBusca por nome, e-mail ou telefone.
tagstringSó contatos com esta tag (pelo nome).
pagenumberPágina (começa em 1). Padrão: 1.
limitnumberItens por página, de 1 a 100. Padrão: 25.
curl -X GET "https://api.zapychat.com.br/api/v1/public/contacts?limit=10" \
  -H "Authorization: Bearer pk_sua_chave"
Resposta · 200
{
  "data": {
    "items": [
      {
        "id": "cmf2xyz789",
        "name": "Maria Souza",
        "phone": "5571999990000",
        "email": "maria@exemplo.com",
        "notes": null,
        "optedOut": false,
        "tags": [
          {
            "id": "cmf4tag001",
            "name": "VIP",
            "color": "#6366f1"
          }
        ],
        "createdAt": "2026-09-20T10:00:00.000Z",
        "updatedAt": "2026-10-05T14:10:00.000Z"
      }
    ],
    "total": 1,
    "page": 1,
    "limit": 25
  },
  "meta": {
    "timestamp": "2026-10-05T14:32:10.000Z"
  }
}