Test Cases

List test cases

List saved test cases for a workspace.

get/api/cases

Request

Query parameters

projectIdstring uuid required
type'web' | 'mobile' | 'desktop' | 'multi_device'
searchstring

Free-text match on title, description, or scenario.

directoryIdstring

Filter cases by directory (IDs from GET /api/directories). Pass a UUID to filter to that directory, or an empty string (?directoryId=) to filter to cases not in any directory. Omit the parameter entirely to include all cases.

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.

temporary'true' | 'false'

true lists only temporary cases (those carrying the reserved tag aximo:temporary), false only reusable ones. Omit it to list both.

pageinteger
pageSizeinteger
sort'title' | 'createdAt' | 'updatedAt' | 'lastRunAt' | 'lastStatus'

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 case list.

totalCountinteger required
pageinteger required
pageSizeinteger required
totalPagesinteger required

Example response

{
  "items": [
    {
      "tags": [
        "git:sha:3f2c1e9a7b6d5c4e3f2a1b0c9d8e7f6a5b4c3d2e",
        "genesis:pr:1234"
      ]
    }
  ]
}

Changes

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