List spaces

Returns all spaces for an account or environment

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

X-Disable-Hooks"true"Required

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
appstringOptional
Filter by appId
searchstringOptional
Search query for spaces
namespacestringOptional
Search by namespace
archivedbooleanOptional
Flag to include archived spaces
sortFieldenumOptional

Field to sort spaces by; requires sortDirection if provided.

sortDirectionenumOptional

Direction of sorting; requires sortField if provided.

Allowed values:
isCollaborativebooleanOptional

Flag for collaborative (project) spaces

appIdstringOptionalDeprecated

(Deprecated!) Use app query parameter

isAppTemplatebooleanOptional
Flag for app templates

Response

This endpoint returns an object.
datalist of objects
paginationobject or null
pagination info

Errors