GET
Get interactions

Headers

X-API-Key
string | null

Path Parameters

org_id
string
required

Organization ID

workspace_id
string
required

Workspace ID

app_id
string
required

Agent ID

Query Parameters

sort_by
string | null

Field to sort by

sort_order
string | null

Sort order (asc or desc)

start_datetime
string<date-time>
required

Filter start datetime in UTC (ISO8601)

end_datetime
string<date-time>
required

Filter end datetime in UTC (ISO8601)

limit
integer
default:20

Max number of records to return

Required range: 1 <= x <= 1000
offset
integer
default:0

Number of records to skip

Required range: x >= 0
filter_conditions
string | null

JSON array of filter conditions. Each condition has: id (string), field (from available fields), operator (equals/not_equals/includes/starts_with/ends_with for strings; equals/not_equals/greater_than/less_than for numbers), value. Example: [{"id":"1","field":"interaction_id","operator":"equals","value":"abc123"}]

Response

Successful Response

items
ExternalInteractionsAPIResponse · object[]
required
total
integer
required
limit
integer
required
offset
integer
required
next_page_uri
string | null
prev_page_uri
string | null