> ## Documentation Index > Fetch the complete documentation index at: https://docs.tracecat.com/llms.txt > Use this file to discover all available pages before exploring further. # List Items > List inbox items with cursor-based pagination. Supports sorting by created_at or updated_at. Default sort is by created_at descending. ## OpenAPI ````yaml https://platform.tracecat.com/api/openapi.json get /workspaces/{workspace_id}/inbox/items openapi: 3.1.0 info: title: Tracecat API summary: Tracecat API description: The open source AI automation platform for security teams and agents. termsOfService: >- https://docs.google.com/document/d/e/2PACX-1vQvDe3SoVAPoQc51MgfGCP71IqFYX_rMVEde8zC4qmBCec5f8PLKQRdxa6tsUABT8gWAR9J-EVs2CrQ/pub contact: name: Tracecat Founders email: founders@tracecat.com license: name: AGPL-3.0 url: https://www.gnu.org/licenses/agpl-3.0.html version: '1' servers: - url: /api security: [] tags: - name: public description: Public facing endpoints - name: workflows description: Workflow management - name: actions description: Action management - name: triggers description: Workflow triggers - name: secrets description: Secret management - name: variables description: Workspace variable management paths: /workspaces/{workspace_id}/inbox/items: get: tags: - inbox summary: List Items description: |- List inbox items with cursor-based pagination. Supports sorting by created_at or updated_at. Default sort is by created_at descending. operationId: inbox-list_items parameters: - name: workspace_id in: path required: true schema: type: string format: uuid title: Workspace Id - name: limit in: query required: false schema: type: integer maximum: 200 minimum: 1 default: 20 title: Limit - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' title: Cursor - name: reverse in: query required: false schema: type: boolean default: false title: Reverse - name: order_by in: query required: false schema: anyOf: - enum: - created_at - updated_at type: string - type: 'null' description: Column name to order by (created_at, updated_at) title: Order By description: Column name to order by (created_at, updated_at) - name: sort in: query required: false schema: anyOf: - enum: - asc - desc type: string - type: 'null' description: Sort direction (asc or desc) title: Sort description: Sort direction (asc or desc) - name: search in: query required: false schema: anyOf: - type: string maxLength: 200 - type: 'null' description: Case-insensitive search on item title title: Search description: Case-insensitive search on item title - name: group in: query required: false schema: anyOf: - $ref: '#/components/schemas/InboxGroup' - type: 'null' description: Filter items to a single display group title: Group description: Filter items to a single display group - name: entity_type in: query required: false schema: anyOf: - $ref: '#/components/schemas/AgentSessionEntity' - type: 'null' description: Filter items to a single entity type title: Entity Type description: Filter items to a single entity type - name: created_after in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' description: Only items created at or after this time (ISO 8601) title: Created After description: Only items created at or after this time (ISO 8601) - name: updated_after in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' description: Only items updated at or after this time (ISO 8601) title: Updated After description: Only items updated at or after this time (ISO 8601) responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CursorPaginatedResponse_InboxItemRead_' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyCookie: [] components: schemas: InboxGroup: type: string enum: - review_required - running - error - completed title: InboxGroup description: >- 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. AgentSessionEntity: type: string enum: - case - agent_preset - agent_preset_builder - copilot - workflow - approval - external_channel title: AgentSessionEntity description: |- 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) CursorPaginatedResponse_InboxItemRead_: properties: items: items: $ref: '#/components/schemas/InboxItemRead' type: array title: Items next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: Cursor for next page prev_cursor: anyOf: - type: string - type: 'null' title: Prev Cursor description: Cursor for previous page has_more: type: boolean title: Has More description: Whether more items exist default: false has_previous: type: boolean title: Has Previous description: Whether previous items exist default: false total_estimate: anyOf: - type: integer - type: 'null' title: Total Estimate description: Estimated total count from table statistics type: object required: - items title: CursorPaginatedResponse[InboxItemRead] HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError InboxItemRead: properties: id: type: string format: uuid title: Id description: Unique inbox item ID type: $ref: '#/components/schemas/InboxItemType' description: Type of inbox item title: type: string title: Title description: Display title preview: type: string title: Preview description: Preview text status: $ref: '#/components/schemas/InboxItemStatus' description: Item status unread: type: boolean title: Unread description: Whether the item is unread created_at: type: string format: date-time title: Created At description: Creation timestamp updated_at: type: string format: date-time title: Updated At description: Last update timestamp workflow: anyOf: - $ref: '#/components/schemas/WorkflowSummary' - type: 'null' description: Associated workflow created_by: anyOf: - $ref: '#/components/schemas/UserSummary' - type: 'null' description: >- User who created the source entity (None for automation-initiated items) source_id: type: string format: uuid title: Source Id description: ID of the source entity source_type: type: string title: Source Type description: Type of source entity (e.g., agent_session) metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Metadata description: Type-specific metadata type: object required: - id - type - title - preview - status - unread - created_at - updated_at - source_id - source_type title: InboxItemRead description: Read model for inbox items. ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError InboxItemType: type: string enum: - approval - agent_run title: InboxItemType description: Types of inbox items. InboxItemStatus: type: string enum: - pending - completed - failed title: InboxItemStatus description: Status of inbox items. WorkflowSummary: properties: id: type: string format: uuid title: Id description: Workflow ID title: type: string title: Title description: Workflow title alias: anyOf: - type: string - type: 'null' title: Alias description: Workflow alias type: object required: - id - title title: WorkflowSummary description: Summary of a workflow for inbox item context. UserSummary: properties: id: type: string format: uuid title: Id description: User ID email: type: string title: Email description: User email first_name: anyOf: - type: string - type: 'null' title: First Name description: User first name last_name: anyOf: - type: string - type: 'null' title: Last Name description: User last name type: object required: - id - email title: UserSummary description: Summary of a user for inbox item context. securitySchemes: APIKeyCookie: type: apiKey in: cookie name: fastapiusersauth ````