Lists an authenticated principal's exact mailbox without advancing or acknowledging it.

GET

/v1/m/sessions/inbox

curl --request GET \
  --url 'https://example.com/v1/m/sessions/inbox?workspace_id=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0&limit=50' \
  --header 'Authorization: Bearer <token>'

• this engine

Lists an authenticated principal’s exact mailbox without advancing or acknowledging it.

Authorizations

• bearerAuth
• browserSession

Parameters

Header Parameters

X-Olivares-Tenant

string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Query Parameters

workspace_id

required

string format: uuid

/^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/

Canonical stored workspace UUID selected for this personal collection; it is revalidated and never grants authority.

continuation

string

>= 1 characters <= 2048 characters

Opaque authenticated c2n1 continuation returned by the preceding page; raw delivery positions are not accepted.

limit

integer

default: 50 >= 1 <= 200

Visible page size from 1 through 200; default 50.

Responses

200

Visible personal inbox page

Media type application/json

object

continuation

Opaque c2n1 next-page token; omitted on the final page.

string

cursor_target

Opaque c2n1 target for the last returned Delivery.

string

has_more

required

boolean

items

required

Array<object>

object

delivery

required

object

ack_due_at

Any of:

string

string format: date-time

null

null

acknowledged_at

Any of:

string

string format: date-time

null

null

available_at

required

string format: date-time

delivery_seq

required

integer format: int64

expires_at

Any of:

string

string format: date-time

null

null

first_seen_at

Any of:

string

string format: date-time

null

null

id

required

string format: uuid

message_id

required

string format: uuid

recipient

required

object

kind

required

string

Allowed values: user agent session

ref

required

string

>= 1 characters <= 1024 characters

required

required

boolean

state

required

string

version

required

integer format: int64

fulfillment

required

object

acknowledged

required

integer format: int64

quorum

integer format: int64

required

required

integer format: int64

state

required

string

unmet

required

integer format: int64

viable

required

integer format: int64

message

required

object

ack_due_at

Any of:

string

string format: date-time

null

null

ack_policy

required

string

ack_quorum

integer format: int64

available_at

required

string format: date-time

channel_id

required

string format: uuid

content

required

object

blocks

required

Array<object>

>= 1 items <= 64 items

object

code

string

format

string

Allowed values: "" plain markdown

reference

Any of:

object

object

hash

string

kind

required

string

>= 1 characters

ref

required

string

>= 1 characters

null

null

text

string

type

required

string

Allowed values: text reference status action_ref

subject

required

string

expires_at

Any of:

string

string format: date-time

null

null

id

required

string format: uuid

published_at

Any of:

string

string format: date-time

null

null

sender

required

object

kind

required

string

Allowed values: user agent session system

ref

required

string

>= 1 characters <= 1024 characters

state

required

string

terminal_at

Any of:

string

string format: date-time

null

null

terminal_code

string

thread_id

required

string format: uuid

urgency

required

string

version

required

integer format: int64

Example

{
  "items": [
    {
      "delivery": {
        "recipient": {
          "kind": "user"
        }
      },
      "message": {
        "content": {
          "blocks": [
            {
              "format": "",
              "type": "text"
            }
          ]
        },
        "sender": {
          "kind": "user"
        }
      }
    }
  ]
}

400

Bad request

Media type application/json

object

Example ^generated

{}

401

Unauthenticated

Media type application/json

object

Example ^generated

{}

403

Forbidden

Media type application/json

object

Example ^generated

{}

404

Not found

Media type application/json

object

Example ^generated

{}

412

Precondition failed

Media type application/json

object

Example ^generated

{}

429

Rate limited

Media type application/json

object

Example ^generated

{}

503

Current authority, custody or store evidence is unavailable; or, with code commit_outcome_unknown, the write was issued and its outcome was never learned, so it may be durable and must not be retried automatically

Media type application/json

object

Example ^generated

{}