List spaces

GET

Returns all spaces for an account or environment

Headers

X-Disable-Hooks"true"RequiredDefaults to true

Query parameters

environmentIdstringOptional

The ID of the environment.

pageSizeintegerOptional

Number of spaces to return in a page (default 10)

pageNumberintegerOptional

Based on pageSize, which page of records to return

searchstringOptional

Search query for spaces

namespacestringOptional

Search by namespace

archivedbooleanOptional

Flag to include archived spaces

sortFieldenumOptional

Field to sort spaces by

sortDirection"asc" or "desc"Optional

Direction of sorting

Allowed values: ascdesc
isCollaborativebooleanOptional

Flag for collaborative (project) spaces

Response

This endpoint returns an object.
datalist of objects
paginationobjectOptional

pagination info

Errors