Skip to main content
GET
List conversations

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

agentId
string
required

Unique identifier of the agent

Example:

"clx1234567890abcdef"

page
integer

Page number for pagination (default: 1)

Required range: x >= 1
Example:

1

perPage
integer

Number of conversations per page (default: 20, max: 100)

Required range: 1 <= x <= 100
Example:

20

type
enum<string>

Type of conversations to retrieve

Available options:
unassigned,
your-inbox,
all
Example:

"all"

sort
enum<string>

Sort order for lastMessageDate (default: desc)

Available options:
asc,
desc
Example:

"desc"

status
enum<string>

Filter by conversation status

Available options:
open,
close
Example:

"open"

startDate
string

Filter by start date. Supports Unix timestamp in seconds (e.g., 1747196400) or ISO 8601 format (e.g., 2024-01-01)

Example:

"2024-01-01"

endDate
string

Filter by end date. Supports Unix timestamp in seconds (e.g., 1747200000) or ISO 8601 format (e.g., 2024-01-31)

Example:

"2024-01-31"

assignedTo
string

Filter by assigned agent ID. Use 'ai' for AI-handled conversations (no human agent assigned)

Example:

"user_1234567890"

sentiment
enum<string>

Filter by conversation sentiment

Available options:
POSITIVE,
NEGATIVE,
NEUTRAL,
UNSPECIFIED
Example:

"POSITIVE"

topic
string

Filter by conversation topic name

Example:

"billing"

channel
enum<string>

Filter by conversation channel (integration type or chat type)

Available options:
WHATSAPP,
SLACK,
MESSENGER,
FULLPAGE,
INLINECHAT,
PREVIEW,
ONBOARDING
Example:

"WHATSAPP"

resolutionStatus
enum<string>

Filter by resolution status

Available options:
AIHelped,
AIDidNotHelp,
TalkToAgent
Example:

"AIHelped"

viewId
string

Filter using a saved inbox view ID. When provided, applies all filters configured in the inbox view. Create inbox views from the dashboard. Other filters can be combined with viewId

Example:

"clx1234567890viewid"

Response

Successfully retrieved conversations list

status
string
Example:

"success"

data
object