Skip to navigation

List

List interactions for a user.

Authentication

Authorizationstring
API Key authentication via header

Query parameters

sizeintegerOptional1-100Defaults to 50
pageintegerOptional>=1Defaults to 1
sort_orderenum or nullOptional

Sort order (asc or desc)

Allowed values:
end_timestringRequiredformat: "date-time"
Timestamp for the latest interaction to include.
start_timestring or nullOptionalformat: "date-time"
Timestamp for the earliest interaction to include. When unset, history extends to the channel's oldest row.
sourceenum or nullOptional
The source of the interaction.
Allowed values:
agent_idstring or nullOptionalformat: "uuid"
The ID of the agent for which to get interactions.
channel_idstring or nullOptionalformat: "uuid"
The ID of the channel for which to get interactions.
typeenum or nullOptional
The type of interaction to get.
Allowed values:
include_nested_interactionsbooleanOptionalDefaults to false
Whether to include nested interactions.
include_incompleteboolean or nullOptional
Whether to include incomplete interactions.
include_external_agentsbooleanOptionalDefaults to false

Include channels where external agent participants (e.g., ASI chats) have addresses matching agents in the organization.

around_sequenceinteger or nullOptional

Return a window of messages centered on this per-channel sequence. Mutually exclusive with before_sequence and after_sequence. Requires channel_id. end_time is still required but ignored.

before_sequenceinteger or nullOptional

Return messages with sequence strictly less than this value. Replaces page offset. Requires channel_id.

after_sequenceinteger or nullOptional

Return messages with sequence strictly greater than this value. Replaces page offset. Requires channel_id.

include_tool_progressbooleanOptionalDefaults to false

Include the latest in-flight tool progress update per running tool call as ephemeral tool_call_update interactions on the first page. Off by default; responses are unchanged unless requested.

Response

Successful Response
itemslist of objects
metaobject

Errors

422
Unprocessable Entity Error