List Cases

Error

A valid request URL is required to generate request examples

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "short_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "summary": "<string>",
      "status": "unknown",
      "priority": "unknown",
      "severity": "unknown",
      "dropdown_values": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "definition_ref": "<string>",
          "definition_name": "<string>",
          "option_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "option_label": "<string>",
          "option_ref": "<string>",
          "option_icon_name": "<string>",
          "option_color": "<string>"
        }
      ],
      "num_sub_cases": 123,
      "is_exact_match": false,
      "is_outside_filters": false,
      "search_match": {
        "score": 1,
        "matched_columns": [
          "summary"
        ],
        "excerpts": [
          "<string>"
        ]
      },
      "assignee": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "jsmith@example.com",
        "role": "basic",
        "settings": {},
        "is_active": true,
        "is_superuser": false,
        "is_verified": false,
        "first_name": "<string>",
        "last_name": "<string>"
      },
      "tags": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "ref": "<string>",
          "color": "<string>"
        }
      ],
      "rows": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "case_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "row_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "table_name": "<string>",
          "row_data": {},
          "is_row_available": true
        }
      ],
      "durations": [
        {
          "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "case_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "start_event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "end_event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "started_at": "2023-11-07T05:31:56Z",
          "ended_at": "2023-11-07T05:31:56Z",
          "duration": "<string>"
        }
      ],
      "field_values": {},
      "payload": {},
      "num_tasks_completed": 0,
      "num_tasks_total": 0,
      "parent": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "short_id": "<string>",
        "summary": "<string>"
      }
    }
  ],
  "next_cursor": "<string>",
  "prev_cursor": "<string>",
  "has_more": false,
  "has_previous": false,
  "total_estimate": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

GET

workspaces

{workspace_id}

cases

Error

A valid request URL is required to generate request examples

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "short_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "summary": "<string>",
      "status": "unknown",
      "priority": "unknown",
      "severity": "unknown",
      "dropdown_values": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "definition_ref": "<string>",
          "definition_name": "<string>",
          "option_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "option_label": "<string>",
          "option_ref": "<string>",
          "option_icon_name": "<string>",
          "option_color": "<string>"
        }
      ],
      "num_sub_cases": 123,
      "is_exact_match": false,
      "is_outside_filters": false,
      "search_match": {
        "score": 1,
        "matched_columns": [
          "summary"
        ],
        "excerpts": [
          "<string>"
        ]
      },
      "assignee": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "jsmith@example.com",
        "role": "basic",
        "settings": {},
        "is_active": true,
        "is_superuser": false,
        "is_verified": false,
        "first_name": "<string>",
        "last_name": "<string>"
      },
      "tags": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "ref": "<string>",
          "color": "<string>"
        }
      ],
      "rows": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "case_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "row_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "table_name": "<string>",
          "row_data": {},
          "is_row_available": true
        }
      ],
      "durations": [
        {
          "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "case_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "start_event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "end_event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "started_at": "2023-11-07T05:31:56Z",
          "ended_at": "2023-11-07T05:31:56Z",
          "duration": "<string>"
        }
      ],
      "field_values": {},
      "payload": {},
      "num_tasks_completed": 0,
      "num_tasks_total": 0,
      "parent": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "short_id": "<string>",
        "summary": "<string>"
      }
    }
  ],
  "next_cursor": "<string>",
  "prev_cursor": "<string>",
  "has_more": false,
  "has_previous": false,
  "total_estimate": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

fastapiusersauth

string

required

Path Parameters

workspace_id

string<uuid>

required

Query Parameters

limit

integer

default:20

Maximum items per page

Required range: 1 <= x <= 200

cursor

string | null

Cursor for pagination

reverse

boolean

default:false

Reverse pagination direction

order_by

enum<string> | null

Column name to order by (e.g. created_at, updated_at, priority, severity, status, tasks, assignee, tags). Default: created_at

Available options:

created_at,

updated_at,

priority,

severity,

status,

tasks,

assignee,

tags

sort

enum<string> | null

Direction to sort (asc or desc)

Available options:

asc,

desc

include_rows

boolean

default:false

Include linked table rows

field_ids

string[] | null

Include only the requested custom field IDs

include_durations

boolean

default:false

Include case duration values

include_payload

boolean

default:false

Include case payload

payload_fields

string[] | null

Return only these literal top-level payload keys, automatically including the subset regardless of include_payload. Dots are literal; nested values are returned whole. Missing keys are omitted and null values preserved. An empty list acts as omitted; an empty string selects the literal empty key.

include_count

boolean

default:true

Include the exact filtered total_estimate for compatibility. Set false when fetching aggregate counts separately; total_estimate will be null.

hierarchy

enum<string>

default:all

Return every case, or only top-level cases without a parent.

Available options:

all,

top_level

payload_paths

string | null

JSON-encoded array of up to 100 object paths, e.g. [["alert","source","ip"]]. Each path contains 1 to 32 literal keys. Preserves nesting, combines with payload_fields, and includes the subset automatically. Selected parents include their whole value. Missing paths are omitted; nulls are preserved. Arrays can be selected whole, without index traversal. An empty list acts as omitted.

Response

Successful Response

items

CaseReadMinimal · object[]

required

Show child attributes

next_cursor

string | null

Cursor for next page

prev_cursor

string | null

Cursor for previous page

has_more

boolean

default:false

Whether more items exist

has_previous

boolean

default:false

Whether previous items exist

total_estimate

integer | null

Estimated total count from table statistics

Core concepts

Endpoints

Authorizations

Path Parameters

Query Parameters

Response