Pular para o conteúdo principal
GET
/
v1
/
contacts
Consultar conversas / contatos
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
  }
}

Autorizações

x-company-key
string
header
obrigatório

Chave de autenticação do workspace (gerada na plataforma Liderhub)

Parâmetros de consulta

number
string

Filtrar por número de telefone

Exemplo:

"5511999999999"

connection
string

Filtrar por ID da conexão

Exemplo:

"aaaaaaaa-bbbb-cccc-dddd-111111111111"

id
string<uuid>

UUID do chat/contato (Chat.id) — filtra no máximo um registro

Exemplo:

"1cbcb7a8-8bf6-4016-8ed5-8ea38c4a9a05"

createdAfter
string

Filtrar contacts criados após esta data (ISO 8601)

Exemplo:

"2026-01-01T00:00:00Z"

createdBefore
string

Filtrar contacts criados antes desta data (ISO 8601)

Exemplo:

"2026-12-31T23:59:59Z"

modifiedAfter
string

Filtrar contacts modificados após esta data (ISO 8601)

Exemplo:

"2026-01-01T00:00:00Z"

modifiedBefore
string

Filtrar contacts modificados antes desta data (ISO 8601)

Exemplo:

"2026-12-31T23:59:59Z"

status
string

Filtrar por ID do status (UUID)

Exemplo:

"aaaaaaaa-bbbb-cccc-dddd-111111111111"

stage
enum<string>

Filtrar por estágio do ticket

Opções disponíveis:
Open,
Closed,
Pending
hasUnread
boolean

Filtrar contacts com mensagens não lidas (true/false)

Exemplo:

true

department
string

Filtrar por ID do departamento (UUID)

Exemplo:

"aaaaaaaa-bbbb-cccc-dddd-111111111111"

tags
string

Filtrar por tag(s) — UUIDs separados por vírgula

Exemplo:

"aaaaaaaa-bbbb-cccc-dddd-111111111111"

page
number
padrão:1

Página (começa em 1, padrão: 1)

Exemplo:

1

limit
number
padrão:20

Itens por página (padrão: 20, máximo: 100)

Exemplo:

20

Resposta

Lista de conversas retornada com sucesso

contacts
object[]
obrigatório
pagination
object
obrigatório

Pagination metadata for chat listing

Last modified on April 21, 2026