Sign in

v1

latestOpenAPI 3.0.32026-07-13218142597.2 KB
Space

Get spaces

Returns all spaces. The results will be sorted by id ascending. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header.

Permissions required: Permission to access the Confluence site ('Can use' global permission). Only spaces that the user has permission to view will be returned.

get/spaces

Query parameters

idsinteger[]

Filter the results to spaces based on their IDs. Multiple IDs can be specified as a comma-separated list.

keysstring[]

Filter the results to spaces based on their keys. Multiple keys can be specified as a comma-separated list.

type'global' | 'collaboration' | 'knowledge_base' | 'personal' | 'system' | 'onboarding' | 'xflow_sample_space'

Filter the results to spaces based on their type.

status'current' | 'archived'

Filter the results to spaces based on their status.

labelsstring[]

Filter the results to spaces based on their labels. Multiple labels can be specified as a comma-separated list.

favorited-bystring

Filter the results to spaces favorited by the user with the specified account ID.

not-favorited-bystring

Filter the results to spaces NOT favorited by the user with the specified account ID.

sort'id' | '-id' | 'key' | '-key' | 'name' | '-name'

The sort fields for spaces. The default sort direction is ascending. To sort in descending order, append a - character before the sort field. For example, fieldName or -fieldName.

Used to sort the result by a particular field.

description-format'plain' | 'view'

The formats a space description can be represented as. A subset of BodyRepresentation.

The content format type to be returned in the description field of the response. If available, the representation will be available under a response field of the same name under the description field.

include-iconboolean

If the icon for the space should be fetched or not.

cursorstring

Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.

limitinteger

Maximum number of spaces per result to return. If more results exist, use the Link response header to retrieve a relative URL that will return the next set of results.

Response

Returned if the requested spaces are returned.