Skip to navigation

List tickets

List an agent’s conversation triage tickets, ordered by most recently created first unless sorted by priority. These are tickets about the agent’s own performance on a conversation (for triage with Architect), not tickets an agent opens for end users.

Path parameters

agent_idstringRequired

Headers

xi-api-keystringOptional

Query parameters

page_sizeintegerOptional1-100Defaults to 100
How many agent conversation tickets to return. Can not exceed 100.
conversation_idstring or nullOptional
Filter tickets by conversation id.
statusenum or nullOptional
Filter tickets by status.
Allowed values:
sourceslist of enums or nullOptional

Filter tickets by how they were raised (qa, agent, manual). Repeat the parameter to filter by multiple sources.

Allowed values:
prioritieslist of enums or nullOptional
Filter tickets by priority. Repeat the parameter to filter by multiple priorities.
Allowed values:
sort_byenumOptional

Order by most recently created, or by priority (most urgent first, then most recently created).

Allowed values:
owner_user_idstring or nullOptional

Filter tickets by creator. Use ‘agent’ for agent-raised tickets.

assignee_user_idstring or nullOptional
Filter tickets by assignee. Use 'unassigned' for tickets with no assignee.
issue_typeenum or nullOptional
Filter clusters by issue type.
labelstring or nullOptional
Filter tickets by an exact label.
merged_into_ticket_idstring or nullOptional
Filter tickets merged into this ticket.
searchstring or nullOptional<=200 characters

Case-insensitive free-text search across the ticket’s title, description, comments, and turn comments.

cursorstring or nullOptional
Used for fetching next page. Cursor is returned in the response.

Response

Successful Response
agent_conversation_ticketslist of objects
has_moreboolean
next_cursorstring or nullOptional

Errors

422
Unprocessable Entity Error