Docmost Octri Preview
POST/labels

List labels in the workspace

Lists labels in the workspace. Set type to page and use the cursor fields to move between result pages; limit defaults to 20 and accepts values from 1 to 100. Use query to filter labels and adminView to include items the authenticated user can access through the admin role.

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

6 body fields

Label listing criteria and cursor-based pagination options.

typestringrequired
Only page labels are supported today.
Allowed:page
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 list of workspace labels.
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. type must be page; when supplied, limit must be between 1 and 100.