Skip to main content
GET
List agent sessions

Authorizations

Authorization
string
header
required

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

Query Parameters

limit
integer

Maximum number of items to return (1-1000)

Required range: 1 <= x <= 1000
cursor
string

Pagination cursor from a previous response

workspaceElementType
enum<string>
Available options:
tenant,
app,
connector,
oauth-client,
action,
connection,
browser-session,
agent-session,
data-table,
data-table-record,
external-event-log-record,
external-event-pull,
event-source,
event-listener,
action-run-log-record,
external-api-log-record,
incoming-webhook-log-record,
external-reference,
job,
deliverable,
receipt,
job-contract,
job-operator-assignment,
crew-member,
routine,
routine-run,
task,
intake,
command-execution,
canvas,
screen,
file,
knowledge-article,
source-tree,
source-tree-version,
source-module
workspaceElementId
string

Return sessions started from or associated with this element. Pair with relatedElementId.

Available options:
tenant,
app,
connector,
oauth-client,
action,
connection,
browser-session,
agent-session,
data-table,
data-table-record,
external-event-log-record,
external-event-pull,
event-source,
event-listener,
action-run-log-record,
external-api-log-record,
incoming-webhook-log-record,
external-reference,
job,
deliverable,
receipt,
job-contract,
job-operator-assignment,
crew-member,
routine,
routine-run,
task,
intake,
command-execution,
canvas,
screen,
file,
knowledge-article,
source-tree,
source-tree-version,
source-module

Return sessions started from or associated with this element. Pair with relatedElementType.

agentHarnessId
string
preset
enum<string>

Filter sessions by the preset (situation) the agent ran in.

Available options:
general,
canvas,
screen,
data,
events,
knowledge,
connection,
action,
work,
client,
task,
learning
startDatetime
string<date-time>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
endDatetime
string<date-time>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
status
enum<string>
Available options:
queued,
starting,
running,
completed,
failed,
cancelled
label
string

Return only sessions carrying this exact label — e.g. benchmark for the sessions a benchmark run opened.

Required string length: 1 - 64
isExternal
boolean
includeSubSessions
boolean

Include child sessions in the listing. Omitted by default from user-facing conversation lists.

parentSessionId
string

Pass a session id to fetch its direct children. This takes precedence over includeSubSessions.

Response

200 - application/json
items
object[]
required
cursor
string