Docmost Octri Preview
POST/notifications

List notifications for the authenticated user

Lists notifications for the authenticated user. Use type to select direct notifications, page updates, or both, and use cursor or beforeCursor to navigate the results.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

6 body fields

Notification filters and pagination options. All fields are optional; type defaults to all and limit defaults to 20 when omitted.

typestringoptional
`direct` returns mentions, comments, and permission grants; `updates` returns page-change notifications; `all` returns both.
Allowed:directupdatesallDefault:all
adminViewbooleanoptional
If `true`, the list includes all items the admin has global permissions to access by virtue of their admin role.
beforeCursorstringoptional
Set to `prevCursor` from the previous call to list the previous page. Ignored when `cursor` is also supplied.
cursorstringoptional
Set cursor to `nextCursor` returned by the previous call to list items in the next page.
limitintegeroptional
Maximum number of items to return per page.
Default:20
querystringoptional
Optional text filter to search within the listed items (e.g. filter members by name).

2 status codes
200Returns a paginated response containing notifications.
dataobjectoptional
statusintegeroptional
successbooleanoptional
401Returned when the request is unauthenticated.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 401 is returned when the request is unauthenticated. Send valid credentials in the Authorization header. type must be direct, updates, or all, and limit must be between 1 and 100.