List sessions

Retrieve sessions in the requested order. Items keep that order across pages; use cursor.next or cursor.previous to move through the ordered list.

GET /api/session

List sessions

cURL

curl --request GET \
  --url https://api.example.com/api/session

import requests

url = "https://api.example.com/api/session"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.example.com/api/session', 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 => "https://api.example.com/api/session",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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 := "https://api.example.com/api/session"

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

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/api/session")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/session")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

200

{
  "data": [
    {
      "id": "<string>",
      "projectID": "<string>",
      "cost": 123,
      "tokens": {
        "input": 123,
        "output": 123,
        "reasoning": 123,
        "cache": {
          "read": 123,
          "write": 123
        }
      },
      "time": {
        "created": 123,
        "updated": 123,
        "archived": 123
      },
      "title": "<string>",
      "location": {
        "directory": "<string>",
        "workspaceID": "<string>"
      },
      "parentID": "<string>",
      "fork": {
        "sessionID": "<string>",
        "messageID": "<string>"
      },
      "agent": "<string>",
      "model": {
        "id": "<string>",
        "providerID": "<string>",
        "variant": "<string>"
      },
      "subpath": "<string>",
      "revert": {
        "messageID": "<string>",
        "partID": "<string>",
        "snapshot": "<string>",
        "files": [
          {
            "file": "<string>",
            "patch": "<string>",
            "additions": 1,
            "deletions": 1
          }
        ]
      }
    }
  ],
  "cursor": {
    "previous": "<string>",
    "next": "<string>"
  }
}

{
  "_tag": "InvalidCursorError",
  "message": "<string>"
}

{
  "_tag": "UnauthorizedError",
  "message": "<string>"
}

Query Parameters

workspace · string | null

Pattern: ^wrk

limit · string | null

Maximum number of sessions to return. Defaults to the newest 50 sessions.

order · enum<string> | null

Session order for the first page. Use desc for newest first or asc for oldest first.

Available options: asc, desc

search · string | null

parentID · string enum<string>

Filter by parent session. Use null to return only root sessions.

Pattern: ^ses

directory · string | null

project · string | null

subpath · string | null

cursor · string | null

Opaque pagination cursor returned as cursor.previous or cursor.next in the previous response.

Response

200

application/json

SessionsResponse

data · object[] · required

Show child attributes

cursor · object · required

Show child attributes