List notifications

{ "items": [ { "created_at": "<string>", "event_type": "UserInvited", "id": "<string>", "payload": {}, "read": true, "update_count": 123 } ], "total": 123 }

Authorizations

X-API-Key

string

header

required

Headers

customer

string

required

Workspace identifier

Query Parameters

page

string

1-based page number (default 1)

limit

string

Page size (1-100, default 20)

project_id

string

required

Project scope (REQUIRED). The feed is always mounted under a project, so it must be scoped to one — the @CustomerApi guard then authorises the caller against this project. An omitted scope must NOT fall back to an all-projects read: that would return historical rows (incl. EntityChanged structured diffs) from projects the caller has since lost access to.

branch_id

string

Branch filter: 'master' for Base, a branch UUID, or omit for all

variant_id

string

Variant scope, including its change requests

unread

string

When "true", only unread notifications

type

string

Type filter category: 'item' (entity updates), 'comments', 'reviews' (branch review lifecycle), 'automations' (automation runs, their progress and the items they changed), 'agents' (agent chats waiting on you or finished), or omit/'all' for every type

Response

200 - application/json

items

object[]

required

Show child attributes

total

number

required

Total matching threads across all pages

{ "items": [ { "created_at": "<string>", "event_type": "UserInvited", "id": "<string>", "payload": {}, "read": true, "update_count": 123 } ], "total": 123 }

Quickstart

Automations

Flow MCP

Endpoints

List notifications

Authorizations

Headers

Query Parameters

Response