Skip to content

Notifications

The authenticated user’s notification inbox.

Operation Method + path Token scope Role Notes
List notifications GET /me/notifications.json read or write Authenticated user Paginated, newest first
{
"id": "pXmKbT",
"type": "Membership::JoinRequestReceivedNotifier",
"params": {
"user_name": "Yaro",
"organization_name": "Acme"
},
"record_type": "Membership::JoinRequest",
"record_id": "kRpMnX",
"seen_at": "2026-05-05T08:30:00Z",
"read_at": null,
"created_at": "2026-05-05T08:00:00Z"
}

type is the Noticed event class — use it to dispatch on the notification kind. params is event-specific. record_type / record_id point to the related resource.

GET /me/notifications.json

Returns the user’s notifications, newest first. Excludes submission-message notifications (those are surfaced inline in the chat UI). Paginated — Total-Count, Total-Pages, etc.

Code When
401 Missing token