Sign in
Spaces

List spaces

List spaces in the workspace.

get/spaces

Request

  • Base URL: https://next-api.saturation.io/v1
  • URL: https://next-api.saturation.io/v1/spaces
  • Auth: HTTP bearer

Query parameters

limitinteger

Maximum number of items to return on a page. Capped at 100.

cursorstring

Cursor from the previous page's nextCursor. Use it with the same filters and sort.

sortstring

Field to sort by. Allowed fields depend on the resource.

order'asc' | 'desc'

Sort direction.

withCountboolean

Include the total number of matching items. Defaults to false.

parentIdstring

A stable resource ID, such as prj_…, txn_…, or doc_….

Example:txn_8f2a1c9e

Only spaces directly nested under this parent space.

includeDeletedboolean

Include deleted spaces.

Response

A page of spaces.

nextCursorstring nullable

Cursor for the next page. Pass it as cursor with the same filters and sort. Null on the last page.

countinteger

Total matching items; present only when withCount=true was requested.

truncatedboolean

Whether some matching items were omitted from the response.

Example response

{
  "data": [
    {
      "id": "txn_8f2a1c9e",
      "slug": "features",
      "name": "Features",
      "parentId": "txn_8f2a1c9e"
    }
  ],
  "nextCursor": "eyJpZCI6InR4bl84ZjJhMWM5ZSJ9"
}

Changes

No recorded changes to this operation across all 4 revisions of this API.