List agent sessions
Agent Sessions
List agent sessions
GET
List agent sessions
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Maximum number of items to return (1-1000)
Required range:
1 <= x <= 1000Pagination cursor from a previous response
Available options:
tenant, app, connector, integration, action, connection, data-table, data-table-record, data-sync, data-sync-run, external-event-subscription, external-event-log-record, external-event-pull, external-event-type, action-run-log-record, external-api-log-record, incoming-webhook-log-record, connected-product, external-agent, job, deliverable, deliverable-type, routine, task, canvas, file, knowledge-article, knowledge-sync, knowledge-sync-pull Return sessions started from or associated with this element. Pair with relatedElementId.
Available options:
tenant, app, connector, integration, action, connection, data-table, data-table-record, data-sync, data-sync-run, external-event-subscription, external-event-log-record, external-event-pull, external-event-type, action-run-log-record, external-api-log-record, incoming-webhook-log-record, connected-product, external-agent, job, deliverable, deliverable-type, routine, task, canvas, file, knowledge-article, knowledge-sync, knowledge-sync-pull Return sessions started from or associated with this element. Pair with relatedElementType.
Filter sessions by the preset (situation) the agent ran in.
Available options:
general, canvas, context, connection-build, action-build, task, work, universe 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))$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))$Available options:
queued, starting, running, completed, failed, cancelled When omitted, the listing returns top-level sessions only. Pass a session id to fetch its direct children.