GET
/
agents
/
{
  "items": [
    {
      "agent_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "session_id": "<string>",
      "status": "active",
      "closed_at": "2023-11-07T05:31:56Z",
      "saved": false
    }
  ],
  "page": 123,
  "page_size": 123,
  "has_next": true,
  "has_previous": true
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
page
integer
default:1

Page number

Required range: x >= 1
​
page_size
integer
default:10

Number of items per page

Required range: 1 <= x <= 100
​
only_active
boolean
default:true

Whether to only return active sessions

​
only_saved
boolean
default:false

Whether to only return saved agents

​
only_current_token
boolean
default:false

Whether to only return agents for the current token (apikey)

Response

200
application/json

Successful Response

The response is of type object.