TRtracecat
cases

Query Cases

Search with typed AND/OR/NOT filters and independent result details.

post/workspaces/{workspace_id}/cases/search

Request

  • Base URL
    https://platform.tracecat.com/api
  • Auth
    • API key in cookie fastapiusersauth
    • or HTTP bearer

Path parameters

workspace_idstring uuid required

Request body

limitinteger

Maximum items per page

cursorstring nullable

Cursor for pagination

reverseboolean

Reverse pagination direction

search_termstring nullable
search_mode'full_text' | 'literal'

Explicit lexical modes; omitted table mode remains a legacy policy.

search_columnsstring[] nullable
short_idstring nullable
case_idstring uuid nullable
hierarchy'all' | 'top_level'
parent_idstring uuid nullable
statusCaseStatus[] nullable
priorityCasePriority[] nullable
severityCaseSeverity[] nullable
tagsstring[] nullable
dropdownstring[] nullable
start_timestring date-time nullable
end_timestring date-time nullable
updated_afterstring date-time nullable
updated_beforestring date-time nullable
order_by'relevance' | 'created_at' | 'updated_at' | 'priority' | 'severity' | 'status' | 'tasks' | 'id' | 'short_id' | 'assignee' | 'tags'
sort'asc' | 'desc' nullable
include_rowsboolean
field_idsstring[] nullable
include_durationsboolean
include_payloadboolean
payload_fieldsstring[] nullable
include_countboolean
promote_exact_matchboolean

Place complete case references before filtered text matches within the authorized workspace.

match_noneboolean

The ordinary filter population matches no cases.

Response

Successful Response

next_cursorstring nullable

Cursor for next page

prev_cursorstring nullable

Cursor for previous page

has_moreboolean

Whether more items exist

has_previousboolean

Whether previous items exist

total_estimateinteger nullable

Estimated total count from table statistics

Changes

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