Search 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

search_term

string | null

Text to search for in case summary, description, short ID, or case UUID

search_mode

enum<string> | null

Explicit full_text or literal; omitted mode preserves legacy search. Explicit lexical modes; omitted table mode remains a legacy policy.

Available options:

full_text,

literal

search_columns

enum<string>[] | null

Selected text fields; omitted searches both.

Available options:

summary,

description

short_id

string | null

Search by exact case short ID (e.g. 42 or CASE-0042)

case_id

string<uuid> | null

Filter by exact case UUID

promote_exact_match

boolean

default:false

Place a complete case reference first, even outside view filters. Workspace authorization and explicit identity/relationship constraints remain strict. Filtered counts exclude cases outside the view.

match_none

boolean

default:false

The ordinary filter population is empty; exact promotion may still match.

status

enum<string>[] | null

Filter by case status

Case status values aligned with OCSF Incident Finding status.

Available options:

unknown,

new,

in_progress,

on_hold,

resolved,

closed,

other

priority

enum<string>[] | null

Filter by case priority

Case priority values aligned with urgency levels.

Values: UNKNOWN (0): No priority is assigned LOW (1): Application or personal procedure is unusable, where a workaround is available or a repair is possible MEDIUM (2): Non-critical function or procedure is unusable or hard to use causing operational disruptions with no direct impact on a service's availability. A workaround is available HIGH (3): Critical functionality or network access is interrupted, degraded or unusable, having a severe impact on services availability. No acceptable alternative is possible CRITICAL (4): Interruption making a critical functionality inaccessible or a complete network interruption causing a severe impact on services availability. There is no possible alternative OTHER (99): The priority is not normalized

Available options:

unknown,

low,

medium,

high,

critical,

other

severity

enum<string>[] | null

Filter by case severity

Case severity values aligned with OCSF severity values.

Values: UNKNOWN (0): The event/finding severity is unknown INFORMATIONAL (1): Informational message. No action required LOW (2): The user decides if action is needed MEDIUM (3): Action is required but the situation is not serious at this time HIGH (4): Action is required immediately CRITICAL (5): Action is required immediately and the scope is broad FATAL (6): An error occurred but it is too late to take remedial action OTHER (99): The event/finding severity is not mapped

Available options:

unknown,

informational,

low,

medium,

high,

critical,

fatal,

other

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