Skip to main content
GET
List sessions

Authorizations

Authorization
string
header
required

An API token for one organization. You create and revoke tokens in the dashboard. A token scoped to one App can reach only that App, so give that kind of token to an agent. An organization-wide token can create a short-lived one with POST /api/tokens.

Path Parameters

id
string
required

A unique ID that starts with app_.

Pattern: ^app_[0-9A-Za-z]{24}$
Example:

"app_Zj7XhMgplmTJcp5Dk4vcYuk0"

Query Parameters

limit
integer
default:50

The maximum number of sessions to return.

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

Where to start: the next_cursor of the page before, listed with the same sort. Without it, the list starts with the first sessions.

Required string length: 1 - 4096
sort
string
default:-updated_at

A comma-separated list of fields to sort by: created_at or updated_at. Each field sorts ascending. To sort a field descending, prefix it with -. Ties are sorted by id.

title
string

Returns only sessions whose title contains this text, ignoring case.

Required string length: 1 - 200
status
enum<string>

Returns only sessions with this status.

Available options:
idle,
running,
waiting

Response

One page of sessions.

results
object[]
required

The results in this page.

has_more
boolean
required

True if more results follow this page; false otherwise.

next_cursor
string | null
required

Where the next page starts: to get it, list again with this value as cursor. A cursor from the last page later finds results added after it. Null if the list is empty.