Pular para o conteúdo principal
GET
/
v1
/
chat
Consultar conversas
curl --request GET \
  --url https://api.liderhub.com.br/v1/chat \
  --header 'x-company-key: <api-key>'
{
  "chats": [
    {
      "contactId": "aaaaaaaa-bbbb-cccc-dddd-111111111111",
      "contactNumber": "5511999999999",
      "integration": "WHATSAPP-NON-OFFICIAL",
      "contactName": "João Silva",
      "department": {},
      "status": {},
      "source": {},
      "connection": {},
      "aiAgent": {},
      "humanAgent": {},
      "ticketStatus": "open",
      "createdAt": {},
      "lastInteraction": {},
      "isWhatsAppWindowClosed": {},
      "tags": {}
    }
  ],
  "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"

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

chats
object[]
obrigatório
pagination
object
obrigatório

Pagination metadata for chat listing

Last modified on February 16, 2026