Sessions

List sessions

Returns sessions visible to your organization, newest first. Filter by project, test case, status, or tag. Results are paginated. Archived (soft-deleted) sessions are excluded; they remain readable via GET /api/sessions/{sessionId}, flagged by archivedAt.

get/api/sessions

Request

Query parameters

projectIdstring uuid

Filter by workspace.

caseIdstring uuid

Filter to sessions linked to a specific test case.

status'queued' | 'created' | 'preparing' | 'running' | 'succeeded' | 'failed' | 'terminated' | 'error' | 'archived'

Terminal statuses (stop polling): succeeded, failed, terminated, error, archived.

tagstring[]

Filter by tag. Repeat the parameter to narrow further: a row matches only if it carries every given tag (?tag=git:sha:abc&tag=genesis:pr:42). At most 10, each 1-64 characters; more is refused with 400. Matching is exact and scoped to your organization.

pageinteger
pageSizeinteger
sort'title' | 'createdAt' | 'startedAt' | 'status'

Field to order the list by.

order'asc' | 'desc'
locale'en' | 'ja' | 'ko' | 'und'

ICU collation used to order text fields, so Japanese titles sort by gojuon rather than by byte value. Omit for a locale-independent order.

Response

Paginated session list.

totalCountinteger required
pageinteger required
pageSizeinteger required
totalPagesinteger required

Example response

{
  "items": [
    {
      "tags": [
        "git:sha:3f2c1e9a7b6d5c4e3f2a1b0c9d8e7f6a5b4c3d2e",
        "checkout"
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.