v1
latestOpenAPI 3.0.02026-08-04172371.9 KBList spaces
Retrieves spaces that the current user has access to and match the query.
Query parameters
Action on space. Supports only "?action=publish".
Environment name to filter by. For example, "?environment.name=Development". Use an empty value to return spaces with no environment.
Environment ID to filter by. For example, "?environmentId=67f4fba37f7cbb2f04ce727a". Use an empty value to return spaces with no environment.
Maximum number of spaces to return.
Space name to search and filter for. Case-insensitive open search with wildcards both as prefix and suffix. For example, "?name=fin" will get "finance", "Final" and "Griffin".
The next page cursor. Next links make use of this.
Space ownerId to filter by. For example, "?ownerId=123".
The previous page cursor. Previous links make use of this.
Comma-separated list of roles to filter spaces by the caller's assignment role. For example, "?roles=publisher,facilitator" returns spaces where the caller has the publisher or facilitator role.
Field to sort by. Prefix with +/- to indicate asc/desc. For example, "?sort=+name" to sort ascending on Name. Supported fields are "type", "name" and "createdAt".
Type(s) of space to filter. For example, "?type=managed,shared".
Response
Spaces retrieved.