Docmost Octri Preview
POST/groups

List workspace groups

Lists groups in the workspace, with member counts. Use query to filter the list and cursor or beforeCursor to navigate between pages. Set adminView to include items the admin can access through global admin permissions.

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

5 body fields

Filters and pagination options for the workspace group list.

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 groups with member counts.
dataobjectoptional
statusintegeroptional
successbooleanoptional
403Returned when the authenticated user is not permitted to list workspace groups.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 403 is returned when the authenticated user is not permitted to list workspace groups. limit must be between 1 and 100; it defaults to 20 when omitted. Use cursor or beforeCursor to navigate pages, supplying the corresponding cursor from a previous response.