List the caller's in-app notifications
Notifications for the calling user in this workspace, newest first.
/v1/notificationsViewer- Operation id
- list_notifications
- Access
- Any workspace role can call this.
/v1/notificationsNotifications for the calling user in this workspace, newest first.
Two kinds arrive here: ones addressed to this user, and ones broadcast to every member of the workspace. Both appear in one list and read the same.
unread_count counts every unread notification, not just the page
returned, so it is what a badge should show.
limit defaults to 50 and is capped at 200. A larger value is quietly
reduced rather than refused. There is no offset: this is a recent list, not
a full history.
Set unread_only=true to fetch only what has not been read.
Tenancy: the request is scoped to one workspace, and the credential presented is what selects it. A caller with no membership in that workspace is refused with 404, which is indistinguishable from a workspace that does not exist.
Authorisation: any workspace role, including viewer. Reads are open to every member.
Access: Authorization: Bearer carrying either a realm access token or an API key. A key must hold the notifications:read scope, and the workspace role of the person who owns it must meet the floor above.
A realm-issued access token, presented as Authorization: Bearer <token>. It acts as the person who signed in, and every operation resolves their workspace role live from the membership record.
In: header
Query Parameters
false50Response Body
application/json
application/json
curl -X GET "https://example.com/v1/notifications"{}