API REFERENCEConversations

List conversations

Get all conversations of agents that user owns. With option to restrict to a specific agent.

Headers

xi-api-keystringRequired

Query parameters

cursorstring or nullOptional
Used for fetching next page. Cursor is returned in the response.
agent_idstring or nullOptional
The id of the agent you're taking the action on.
call_successfulenum or nullOptional
The result of the success evaluation
Allowed values:
call_start_before_unixinteger or nullOptional

Unix timestamp (in seconds) to filter conversations up to this start date.

call_start_after_unixinteger or nullOptional

Unix timestamp (in seconds) to filter conversations after to this start date.

page_sizeintegerOptional>=1<=100Defaults to 30
How many conversations to return at maximum. Can not exceed 100, defaults to 30.

Response

Successful Response
conversationslist of objects
has_moreboolean
next_cursorstring or null

Errors