Skip to main content
GET
/
v1
/
agents
/
sessions
List sessions
curl --request GET \
  --url {scheme}://{gatewayBaseURL}/{tenantName}/v1/agents/sessions \
  --header 'Authorization: Bearer <token>'
import requests

url = "{scheme}://{gatewayBaseURL}/{tenantName}/v1/agents/sessions"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('{scheme}://{gatewayBaseURL}/{tenantName}/v1/agents/sessions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "{scheme}://{gatewayBaseURL}/{tenantName}/v1/agents/sessions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "{scheme}://{gatewayBaseURL}/{tenantName}/v1/agents/sessions"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("{scheme}://{gatewayBaseURL}/{tenantName}/v1/agents/sessions")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("{scheme}://{gatewayBaseURL}/{tenantName}/v1/agents/sessions")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "data": [
    {
      "id": "<string>",
      "agent_name": "<string>",
      "title": "<string>",
      "created_by_subject": {
        "subject_id": "<string>",
        "subject_type": "<string>",
        "subject_slug": "<string>"
      },
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "pagination": {
    "limit": 123,
    "next_page_token": "<string>",
    "previous_page_token": "<string>"
  }
}
{
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"param": "<string>"
}
}
{
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"param": "<string>"
}
}
{
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"param": "<string>"
}
}
{
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"param": "<string>"
}
}
{
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"param": "<string>"
}
}

Authorizations

Authorization
string
header
required

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

Query Parameters

agent_name
string
required

Agent whose sessions to list. Must exist in the tenant.

Required string length: 1 - 255
limit
integer
default:10

Page size. Defaults to 10, max 100.

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

Sort sessions by creation time. Defaults to "desc".

Available options:
asc,
desc
page_token
string

Opaque token from a previous response next_page_token.

start_timestamp
string

Inclusive lower bound on created_at (ISO-8601). Defaults upstream to 30 min before end_timestamp.

end_timestamp
string

Inclusive upper bound on created_at (ISO-8601). Defaults upstream to now.

Response

Paginated sessions.

data
object[]
required
pagination
object
required