Skip to main content
GET
/
sessions
{
  "session_example": {
    "summary": "Example session response",
    "value": {
      "data": [
        {
          "session_id": "6f6cfbfd-9643-479a-ae47-b8f32eb4d710",
          "session_name": "What tools do you have?",
          "session_state": {},
          "created_at": "2025-09-05T16:02:09Z",
          "updated_at": "2025-09-05T16:02:09Z"
        }
      ]
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
type
enum<string>
default:agent

Type of sessions to retrieve (agent, team, or workflow)

Available options:
agent,
team,
workflow
​
component_id
string | null

Filter sessions by component ID (agent/team/workflow ID)

​
user_id
string | null

Filter sessions by user ID

​
session_name
string | null

Filter sessions by name (partial match)

​
limit
integer | null
default:20

Number of sessions to return per page

​
page
integer | null
default:1

Page number for pagination

​
sort_by
string | null
default:created_at

Field to sort sessions by

​
sort_order
enum<string> | null
default:desc

Sort order (asc or desc)

Available options:
asc,
desc
​
db_id
string | null

Database ID to query sessions from

​
table
string | null

The database table to use

Response

Sessions retrieved successfully

​
data
SessionSchema · object[]
required

List of items for the current page

​
meta
PaginationInfo · object
required

Pagination metadata