Cowdidocs
API ReferenceNotification Inbox

List my notifications

GET
/v1/user/notifications

Newest first. Omit read and archived to list everything that is not snoozed now; pass read=false&archived=false for the outstanding work. Pass snoozed=true for the snoozed messages.

Authorization

oauth2
AuthorizationBearer <token>

Create a client with POST /v1/oauth/clients, then exchange its credentials for an access token. AUTHORIZATION_CODE clients act on behalf of a signed-in user and always use PKCE; CLIENT_CREDENTIALS clients act as themselves. A client may only be granted scopes its creator already holds — read the grantable list from GET /v1/oauth/clients/scopes.

In: header

Query Parameters

size?integer

Page size (max 100)

Range0 < value
Default20
after?string

Next page cursor

before?string

Previous page cursor

read?boolean

Filter on read state; omit for either

archived?boolean

Filter on archived state; omit for either. An archived message is done: the recipient archived it, or the backend archived it because its work is finished, for example a decided approval. An archived message is also read.

snoozed?boolean

true lists only the messages snoozed now. Omit it, or send false, to list only the messages that are not snoozed now. A message is snoozed now until its snoozed_until time passes.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/user/notifications"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "title": "string",      "body": "string",      "data": {        "property1": "string",        "property2": "string"      },      "group_key": "string",      "seen": true,      "read": true,      "archived": true,      "seen_at": "2019-08-24T14:15:22Z",      "read_at": "2019-08-24T14:15:22Z",      "archived_at": "2019-08-24T14:15:22Z",      "snoozed_until": "2019-08-24T14:15:22Z",      "severity": "HIGH",      "created_at": "2026-09-01T10:15:30Z"    }  ],  "links": {    "next": "/v1/payees?after=eyJpZCI6MX0",    "prev": "/v1/payees?before=eyJpZCI6MX0"  }}
{  "code": "BAD_REQUEST",  "description": "Bad Request"}
{  "code": "UNAUTHORISED",  "description": "Unauthorised"}
{  "code": "FORBIDDEN",  "description": "Forbidden"}
{  "code": "RATE_LIMIT_EXCEEDED",  "description": "Too Many Requests"}
{  "code": "INTERNAL_ERROR",  "description": "Internal Server Error"}

Update the signed-in user's notification preferences PATCH

Changes only the category-channel pairs listed in `preferences`; every other pair keeps its current state. A `schedule` replaces the signed-in user's delivery schedule. Set `schedule.enabled` to false to allow delivery at every time. Preferences are scoped to the organization on the signed-in user's token. A user token calls this on behalf of the signed-in user. Returns 400 when a listed category cannot be disabled, and the whole request is then rejected with no change applied.

Archive many notifications POST

Archives the messages that are not archived and not snoozed now. Send no body, or omit `read`, to archive all of them. Send `read: true` to archive only the read messages. Send `read: false` to archive only the unread messages. Archiving also marks a message as seen and read.