Skip to content
Subako Docs
Esc
↑↓navigate↵open⌘Jpreview

GET /v1/sessions

GET/v1/sessions
Authorization
AuthorizationBearer token · headerrequired
Query parameters
limitinteger<int64>
min 1 · max 200
afterstring<uuid>
orderOrderParam
Newest first when omitted.
Allowed:ascdesc
Header parameters
Kikuvi-Workspacestring<uuid>
Workspace to list from. Required for a user caller; implied by the key for an API key caller.
Responses
200One page, newest first unless order=asc.
itemsSessionBody[]required
Show properties
Array of SessionBody
agent_idstring<uuid>required
agent_version_idstring<uuid>required
created_atstring<date-time>required
created_bySessionCreatorBodyrequired
Who created the session: the header-surface user or the API key a backend presented.
Show properties
One of:
object
display_namestring | nullrequired
primary_emailstring | nullrequired
user_idstring<uuid>required
typestringrequired
Allowed:user
object
api_key_idstring<uuid>required
labelstringrequired
typestringrequired
Allowed:api_key
display_namestringrequired
idstring<uuid>required
statusSessionStatusBodyrequired
Allowed:idleactive
workspace_idstring<uuid>required
next_cursorstring<uuid> | nullrequired
`None` on the last page.
400Bad limit, cursor, or order, a malformed workspace header, or a user caller with no workspace header.
errorErrorDetailrequired
Show properties
codeErrorCoderequired
The machine-readable half of an error response, and the field a client branches on. Closed: every error carries exactly one of these.
Allowed:unauthorizedforbiddennot_foundinvalid_requestconflictclient_outdatedprecondition_failedtoo_many_requestsinternal
messagestringrequired
401Missing, malformed, or invalid bearer token.
errorErrorDetailrequired
Show properties
codeErrorCoderequired
The machine-readable half of an error response, and the field a client branches on. Closed: every error carries exactly one of these.
Allowed:unauthorizedforbiddennot_foundinvalid_requestconflictclient_outdatedprecondition_failedtoo_many_requestsinternal
messagestringrequired
403Caller lacks session.read, or an API key's Kikuvi-Workspace header names another workspace.
errorErrorDetailrequired
Show properties
codeErrorCoderequired
The machine-readable half of an error response, and the field a client branches on. Closed: every error carries exactly one of these.
Allowed:unauthorizedforbiddennot_foundinvalid_requestconflictclient_outdatedprecondition_failedtoo_many_requestsinternal
messagestringrequired
404No such workspace, or the caller cannot see it.
errorErrorDetailrequired
Show properties
codeErrorCoderequired
The machine-readable half of an error response, and the field a client branches on. Closed: every error carries exactly one of these.
Allowed:unauthorizedforbiddennot_foundinvalid_requestconflictclient_outdatedprecondition_failedtoo_many_requestsinternal
messagestringrequired
Try it
Server
Authorization
Parameters
Request
curl -X GET "https://api.us.cloud.subako.ai/v1/sessions" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "items": [
    {
      "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
      "agent_version_id": "1c2a713c-7248-4a56-a9eb-0bdcb3a41741",
      "created_at": "2019-08-24T14:15:22Z",
      "created_by": {
        "display_name": "string",
        "primary_email": "string",
        "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
        "type": "user"
      },
      "display_name": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "status": "idle",
      "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"
    }
  ],
  "next_cursor": "a7ec8888-a9c3-4732-a281-9a08510f220b"
}