Skip to main content
GET
List contacts for CRM

Authorizations

Authorization
string
header
required

Token JWT de autenticação

Headers

x-company-id
string

Target company identifier. Required only for global API keys (type=global). Ignored for company API keys and human users.

Query Parameters

agentId
string

Filter by agent ID

agentStepId
string

Filter by step ID

inboxId
string

Filter by inbox ID

status
string

Filter by status (OPEN, RESOLVED)

userIds
string

Filter by user IDs

startDate
string

Start date to filter conversations (last_activity_at >= startDate)

endDate
string

End date to filter conversations (last_activity_at <= endDate)

advancedFilters
string

Advanced filters in JSON format: [{ field, operator, value }]

page
string
default:1

Page number (starts at 1)

rowsPerPage
string
default:10

Number of items per page

Response

List of contacts with last conversation returned successfully

result
any[]
required

List of contacts

meta
any
required

Pagination metadata