Docmost Octri Preview
POST/spaces

List spaces the authenticated user can access

Lists spaces the authenticated user can access, with member counts. Use query to filter the list and limit to control the page size. Set adminView to include all items the authenticated user can access through their admin role, or use cursor and beforeCursor to navigate pages.

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

5 body fields

Options for filtering and paginating the spaces 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 spaces with member counts.
dataobjectoptional
statusintegeroptional
successbooleanoptional
401Returned when the request is unauthorized.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 401 is returned when authentication fails. limit must be between 1 and 100; use cursor or beforeCursor to navigate pages, not both.