Docmost Octri Preview
POST/favorites/ids

List favorited IDs for one type

Lists the IDs of the authenticated user's favorites for one type. Set type to select pages, spaces, or templates, and optionally set spaceId to restrict the result to one space.

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

2 body fields

Filters for the favorite IDs to return.

spaceIdstringoptional
Restrict the result to one space.
typestringrequired
Favorite type to list: `page`, `space`, or `template`.
Allowed:pagespacetemplate

2 status codes
200Returns an array containing the IDs of favorites matching the requested type and optional space filter.
dataarray<string>optional
statusintegeroptional
successbooleanoptional
401Returned when the request is unauthenticated.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

type is required and must be page, space, or template. A 401 is returned when the request is unauthenticated; send valid credentials in the Authorization header.