Skip to main content
GET
Listar contatos para CRM

Autorizações

Authorization
string
header
obrigatório

Token JWT de autenticação

Cabeçalhos

x-company-id
string

Identificador da empresa-alvo. Obrigatório apenas para API Keys globais (type=global). Ignorado para API Keys de empresa e usuários humanos.

Parâmetros de consulta

agentId
string

Filtrar por ID do agente

agentStepId
string

Filtrar por ID da etapa

inboxId
string

Filtrar por ID do inbox

status
string

Filtrar por status (OPEN, RESOLVED)

userIds
string

Filtrar por IDs dos usuários

startDate
string

Data inicial para filtrar conversas (last_activity_at >= startDate)

endDate
string

Data final para filtrar conversas (last_activity_at <= endDate)

advancedFilters
string

Filtros avançados em formato JSON: [{ field, operator, value }]

page
string
padrão:1

Número da página (começa em 1)

rowsPerPage
string
padrão:10

Quantidade de itens por página

Resposta

Lista de contatos com última conversa retornada com sucesso

result
any[]
obrigatório

Lista de contatos

meta
any
obrigatório

Metadados da paginação