Docmost Octri Preview
POST/labels/pages

List pages carrying a label

Lists pages carrying a specified label. Identify the label with labelId or name, and use spaceId to restrict results to one space; cursor fields let you navigate result pages. An unknown name returns an empty page rather than a 404.

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

8 body fields

Label identification, optional space filtering, and cursor-based pagination criteria.

labelIdstringoptional
The UUID of the label to find pages for; takes precedence over `name` when both are supplied.
namestringoptional
Label name. Normalised to lowercase before lookup.
spaceIdstringoptional
Restrict results to one space.
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).

4 status codes
200Returns a paginated list of pages carrying the identified label.
dataobjectoptional
statusintegeroptional
successbooleanoptional
400Returned when neither `labelId` nor `name` is supplied.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
403Returned when access to the requested results is forbidden.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
404Returned when the identified label is not found.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

labelId or name must be supplied; if both are present, labelId takes precedence. A 400 is returned when neither is supplied, a 403 when access is forbidden, and a 404 when the identified label is not found. name is normalized to lowercase and must not exceed 100 characters.