Skip to main content
GET
List conversations

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

inboxId
string

Filter by inbox ID

agentId
string

Filter by agent ID

teamId
string

Filter by team ID

channel
string

Filter by inbox channel type(s), comma-separated (e.g.: WAP_AUTO_CLOSER,LINKEDIN)

stalled
string

Filter stalled conversations (no contact activity for more than 24h)

transferred
string

Filter conversations transferred from AI to a human attendant

hasFollowUp
string

Filter conversations with a scheduled follow-up

inCampaign
string

Filter conversations originated from a campaign

inService
string

Filter conversations in service (excludes follow-up and campaign)

userIds
string

Filter by user IDs

whoAnswering
string

Filter by who is answering (AGENT/HUMAN)

status
string

Filter by status (OPEN, RESOLVED)

agentStep
string

Filter by IDs of the agent flow steps

engagement
string

Filter by engagement levels

requiresAttention
string

Filter conversations that require attention

hasScheduledMeeting
string

Filter conversations with a scheduled meeting (not canceled)

startDate
string

Start date to filter conversations (createdAt >= startDate)

endDate
string

End date to filter conversations (createdAt <= 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 conversations returned successfully

result
any[]
required

List of conversations

meta
any
required

Pagination metadata