Listar contatos para CRM

Retorna uma lista paginada de contatos com sua última conversa, filtros por etapa, inbox, status, etc.

GET /v1/contacts/crm

Listar contatos para CRM

cURL

curl --request GET \
  --url https://api.nuvia.ai/v1/contacts/crm \
  --header 'Authorization: Bearer <token>'

200

{
  "result": [
    "<unknown>"
  ],
  "meta": "<unknown>"
}

Authorizations

Authorization · string · header · required

Token JWT de autenticação

Headers

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.

Query Parameters

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)

page · string · default: 1

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

rowsPerPage · string · default: 10

Quantidade de itens por página

search · string

Response

200

application/json

Lista de contatos com última conversa retornada com sucesso

result · any[] · required

Lista de contatos

meta · any · required

Metadados da paginação