v1
latestOpenAPI 3.1.02026-08-04222461539.5 KBspaces
List spaces
Returns all spaces for an account or environment
get/spaces
Query parameters
environmentIdstring
Environment ID
The ID of the environment.
pageSizeinteger
Number of spaces to return in a page (default 10)
pageNumberinteger
Based on pageSize, which page of records to return
appstring
App ID
Filter by appId
searchstring
Search query for spaces
namespacestring
Search by namespace
archivedboolean
Flag to include archived spaces
sortField'name' | 'workbooksCount' | 'filesCount' | 'environmentId' | 'createdByUserName' | 'createdAt' | 'lastActivityAt'
Field to sort spaces by; requires sortDirection if provided.
sortDirection'asc' | 'desc'
Sort direction - asc (ascending) or desc (descending)
Direction of sorting; requires sortField if provided.
isCollaborativeboolean
Flag for collaborative (project) spaces
appIdstring
App ID
(Deprecated!) Use app query parameter
isAppTemplateboolean
Flag for app templates
Headers
Authorizationstring required
Bearer authentication
X-Disable-Hooks'true' required
Response
Response with status 200