Skip to main content
GET
/
workspaces
/
{workspace_id}
/
inbox
/
items
Error
A valid request URL is required to generate request examples
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "preview": "<string>",
      "unread": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "source_type": "<string>",
      "workflow": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "title": "<string>",
        "alias": "<string>"
      },
      "created_by": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "<string>",
        "first_name": "<string>",
        "last_name": "<string>"
      },
      "metadata": {}
    }
  ],
  "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
cookie
required

Path Parameters

​
workspace_id
string<uuid>
required

Query Parameters

​
limit
integer
default:20
Required range: 1 <= x <= 200
​
cursor
string | null
​
reverse
boolean
default:false
​
order_by
enum<string> | null

Column name to order by (created_at, updated_at)

Available options:
created_at,
updated_at
​
sort
enum<string> | null

Sort direction (asc or desc)

Available options:
asc,
desc
​
search
string | null

Case-insensitive search on item title

Maximum string length: 200
​
group
enum<string> | null

Filter items to a single display group 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.

Available options:
review_required,
running,
error,
completed
​
entity_type
enum<string> | null

Filter items to a single entity type 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)
Available options:
case,
agent_preset,
agent_preset_builder,
copilot,
workflow,
approval,
external_channel
​
created_after
string<date-time> | null

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

​
updated_after
string<date-time> | null

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

Response

Successful Response

​
items
InboxItemRead · object[]
required
​
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