v1

latestOpenAPI 3.0.32026-07-13218142597.2 KB

Space

Get space by id

Returns a specific space.

Permissions required: Permission to view the space.

get/spaces/{id}

Path parameters

idinteger required

The ID of the space to be returned.

Query parameters

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.

include-operationsboolean

Includes operations associated with this space in the response, as defined in the Operation object. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results.

include-propertiesboolean

Includes space properties associated with this space in the response. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results.

include-permissionsboolean

Includes space permissions associated with this space in the response. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results.

include-role-assignmentsboolean

Includes role assignments associated with this space in the response. This parameter is only accepted for EAP sites. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results.

include-labelsboolean

Includes labels associated with this space in the response. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results.

Response

Returned if the requested space is returned.

idstring

ID of the space.

keystring

Key of the space.

namestring

Name of the space.

The type of space.

status'current' | 'archived'

The status of the space.

authorIdstring

The account ID of the user who created this space originally.

spaceOwnerIdstring

The account ID of the user who owns this space.

createdAtstring date-time

Date and time when the space was created. In format "YYYY-MM-DDTHH:mm:ss.sssZ".

homepageIdstring

ID of the space's homepage.