HypeConversa

Plataforma · Contatos

Listar contatos

Lista os contatos do CRM com paginação por página.

GET
/instances/{INSTANCE_TOKEN}/crm/contacts

Atributos

Cabeçalho

Client-Tokenstringobrigatório

Token da conta. Envie o valor puro, sem o prefixo Bearer.

Query

qstringopcional

Busca por nome ou telefone.

pageintegeropcional

Número da página, começando em 1.

pageSizeintegeropcional

Itens por página, de 1 a 100 (padrão 20).

Resposta

200Veja o corpo de exemplo na referência.
Listar contatos
curl --request GET \
  --url https://api.hypeconversa.com/instances/{INSTANCE_TOKEN}/crm/contacts \
  --header 'Client-Token: SEU_TOKEN_DE_CONTA'
200
json
{
  "items": [
    { "id": "uuid", "name": "Maria", "phone": "5511999999999", "tags": [] }
  ],
  "page": 1,
  "pageSize": 20,
  "total": 1,
  "totalPages": 1
}