curl --request GET \
--url https://api.liderhub.ai/v1/contacts \
--header 'x-company-key: <api-key>'{
"contacts": [
{
"id": "aaaaaaaa-bbbb-cccc-dddd-111111111111",
"contactNumber": "5511999999999",
"integration": "WHATSAPP-NON-OFFICIAL",
"contactName": "João Silva",
"department": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
"status": "cccccccc-cccc-cccc-cccc-cccccccccccc",
"source": "dddddddd-dddd-dddd-dddd-dddddddddddd",
"connection": "eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee",
"agent": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"user": "11111111-2222-3333-4444-555555555555",
"ticketStatus": "open",
"createdAt": "2026-04-16T15:30:00.000Z",
"lastInteraction": "2026-04-16T14:00:00.000Z",
"isWhatsAppWindowClosed": false,
"tags": [
"aaaaaaaa-bbbb-cccc-dddd-111111111111"
]
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 154,
"totalPages": 8,
"hasNextPage": true,
"hasPreviousPage": false
}
}Lista conversas individuais do workspace.
curl --request GET \
--url https://api.liderhub.ai/v1/contacts \
--header 'x-company-key: <api-key>'{
"contacts": [
{
"id": "aaaaaaaa-bbbb-cccc-dddd-111111111111",
"contactNumber": "5511999999999",
"integration": "WHATSAPP-NON-OFFICIAL",
"contactName": "João Silva",
"department": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
"status": "cccccccc-cccc-cccc-cccc-cccccccccccc",
"source": "dddddddd-dddd-dddd-dddd-dddddddddddd",
"connection": "eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee",
"agent": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"user": "11111111-2222-3333-4444-555555555555",
"ticketStatus": "open",
"createdAt": "2026-04-16T15:30:00.000Z",
"lastInteraction": "2026-04-16T14:00:00.000Z",
"isWhatsAppWindowClosed": false,
"tags": [
"aaaaaaaa-bbbb-cccc-dddd-111111111111"
]
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 154,
"totalPages": 8,
"hasNextPage": true,
"hasPreviousPage": false
}
}Chave de autenticação do workspace (gerada na plataforma Liderhub)
Filtrar por número de telefone
"5511999999999"
Filtrar por ID da conexão
"aaaaaaaa-bbbb-cccc-dddd-111111111111"
UUID do chat/contato (Chat.id) — filtra no máximo um registro
"1cbcb7a8-8bf6-4016-8ed5-8ea38c4a9a05"
Filtrar contacts criados após esta data (ISO 8601)
"2026-01-01T00:00:00Z"
Filtrar contacts criados antes desta data (ISO 8601)
"2026-12-31T23:59:59Z"
Filtrar contacts modificados após esta data (ISO 8601)
"2026-01-01T00:00:00Z"
Filtrar contacts modificados antes desta data (ISO 8601)
"2026-12-31T23:59:59Z"
Filtrar por ID do status (UUID)
"aaaaaaaa-bbbb-cccc-dddd-111111111111"
Filtrar por estágio do ticket
Open, Closed, Pending Filtrar contacts com mensagens não lidas (true/false)
true
Filtrar por ID do departamento (UUID)
"aaaaaaaa-bbbb-cccc-dddd-111111111111"
Filtrar por tag(s) — UUIDs separados por vírgula
"aaaaaaaa-bbbb-cccc-dddd-111111111111"
Página (começa em 1, padrão: 1)
1
Itens por página (padrão: 20, máximo: 100)
20
Esta página foi útil?