Skip to navigation

The caller’s inbox

View as Markdown

One page of the caller’s own inbox rows — mentions, approvals, human tasks and unattended parks, plus connector rows for connections whose authorization broke — newest first, read from the inbox_items projection and the connections scan. That pair is ONE reader, shared with GET /me/work, so a broken connection is the same item with the same id on both surfaces (R6-A1); its id is the connection id and POST /workspace/inbox/{itemId}/read dismisses it. connector rows ride the first page only — they are synthesized, so they take no part in the cursor walk — but they always count toward totalCount and unreadCount. Authorization: no per-row check exists or is needed: a row is written FOR one user, so the userId filter IS the scope. status is open (the default) or all, and open means NOT DONE, not unread: a mention leaves it the moment it is read, while an approval, task or parked row that has been read stays until the work behind it closes; limit is 1-50 (default 25); starting_after takes the previous page’s nextCursor. Both are ENFORCED: a bad value is 400 validation_failed, not a silent fallback to the defaults (R7C-04).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

statusenumOptional

open (default) or all. open means NOT DONE, not unread: reading a mention resolves it and drops it from this listing, while a read approval, task or parked row stays until the work behind it closes.

Allowed values:
limitintegerOptional1-50

Page size, 1-50 (default 25). Page one leads with the caller’s broken-connection rows (kind: connector), which are synthesized rather than stored, and the stored page shrinks to keep the total inside limit — at least one stored row always comes through, so a caller whose broken connections alone fill the page receives them plus that row.

starting_afterstringOptional

The previous page’s nextCursor — <ISO-8601 timestamp>|<row id> (a bare timestamp is still accepted). Anything else is 400 validation_failed.

Response

One page of inbox items.
datalist of objects
nextCursorstring or null
unreadCountinteger-9007199254740991-9007199254740991

Unread rows across every page, the badge number. Never counts a resolved (done) row, whatever status asked for, and includes the synthesized broken-connector rows.

totalCountinteger-9007199254740991-9007199254740991

Rows across every page in the SAME set this call pages over: status=open (the default) counts unresolved rows only, status=all counts resolved rows too. Includes the synthesized broken-connector rows.

Errors

400
Bad Request Error