TRtracecat
inbox

List Items

List inbox items with cursor-based pagination.

Supports sorting by created_at or updated_at. Default sort is by created_at descending. Filtering by case requires the case add-ons entitlement.

get/workspaces/{workspace_id}/inbox/items

Request

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

Path parameters

workspace_idstring uuid required

Query parameters

limitinteger
cursorstring nullable
reverseboolean
order_by'created_at' | 'updated_at' nullable

Column name to order by (created_at, updated_at)

sort'asc' | 'desc' nullable

Sort direction (asc or desc)

searchstring nullable

Case-insensitive search on item title

case_idstring uuid nullable

Filter items to root sessions associated with this case

group'review_required' | 'running' | 'error' | 'completed'

Display groups for inbox items.

Groups are derived from approval state and live workflow execution status, so membership cannot be expressed as a pure SQL filter.

Filter items to a single display group

entity_type'case' | 'agent_preset' | 'agent_preset_builder' | 'copilot' | 'workflow' | 'approval' | 'external_channel'

The type of entity associated with an agent session.

Determines the context and behavior of the session:

  • CASE: Chat attached to a Case entity for investigation
  • AGENT_PRESET: Live chat testing a preset configuration
  • AGENT_PRESET_BUILDER: Builder chat for editing/configuring a preset
  • WORKSPACE_CHAT: Workspace-level chat assistant (wire value: copilot)
  • WORKFLOW: Workflow-initiated agent run (from action)
  • APPROVAL: Inbox approval continuation (hidden from main chat list)
  • EXTERNAL_CHANNEL: External channel session (e.g. Slack thread)

Filter items to a single entity type

created_afterstring date-time nullable

Only items created at or after this time (ISO 8601)

updated_afterstring date-time nullable

Only items updated at or after this time (ISO 8601)

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.