Docmost Octri Preview
POST/favorites

List favorites for the authenticated user

Lists favorites for the authenticated user, optionally filtered by space or favorite type. Use cursor or beforeCursor to navigate pages, and query to filter the listed items.

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

7 body fields

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

spaceIdstringoptional
UUID of the space to restrict the favorites to.
typestringoptional
Omit to list favorites of every type.
Allowed:pagespacetemplate
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 the authenticated user's favorites.
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, when supplied, must be page, space, or template, and limit must be between 1 and 100.