Skip to main content
GET
List sessions

Authorizations

Authorization
string
header
required

Caller credential (Authorization: Bearer <token>). Required on protected routes when auth is enabled. Browser sessions may use the HttpOnly id_token or accessToken cookie instead.

Query Parameters

limit
integer
default:25

Page size. Defaults to 25, max 25.

Required range: 1 <= x <= 25
order
enum<string>
default:desc

Sort sessions by updated_at. Defaults to "desc".

Available options:
asc,
desc
page_token
string

Opaque keyset cursor from a previous response next_page_token.

Minimum string length: 1
start_timestamp
string<date-time>

Inclusive lower bound on created_at (ISO-8601 / RFC 3339).

end_timestamp
string<date-time>

Inclusive upper bound on created_at (ISO-8601 / RFC 3339).

agent_id
string

When set, only sessions bound to this agent id are returned.

Minimum string length: 1
created_by_me
boolean

When true, only sessions created by the authenticated subject.

metadata
object

Exact metadata pairs as metadata[key]=value. Sessions must contain all pairs. Caller-owned session metadata

source_type
enum<string>

When set, returns only sessions created by this source type.

Available options:
schedule
source_id
string

When set, returns only sessions from this specific source. Requires source_type.

Minimum string length: 1

Response

Paginated sessions.

data
object[]
required
pagination
object
required