List Spaces

Get a list of spaces.

Required Permission:

• read:space:confluence.

External Documentation

To learn more, visit the Confluence documentation.

​

Basic Parameters

Parameter	Description
Limit	The maximum number of spaces to return in a single response. Values can range from 1 to 250.
Space IDs	A comma-separated list of space IDs to filter results by. Note: A maximum of 250 items can be specified.
Space Keys	A comma-separated list of space keys to filter results by. Note: A maximum of 250 items can be specified.
Status	Select the status of spaces to filter results by.
Type	Select the type of spaces to filter results by.

​

Advanced Parameters

Parameter	Description
Description Format	Select the content format to be returned in the description field of the response.
Favorited By	The account ID of the user whose favorited spaces should be returned.
Include Icon	Select to fetch the icon for the space.
Labels	A comma-separated list of labels to filter results by.
Not Favorited By	The account ID of the user whose non-favorited spaces should be returned.
Sort	Select the primary field for sorting the results. Prefix the value with a minus sign for descending order.

​

Example Output

{
	"results": [
		{
			"id": "<string>",
			"key": "<string>",
			"name": "<string>",
			"type": "global",
			"status": "current",
			"authorId": "<string>",
			"spaceOwnerId": "<string>",
			"currentActiveAlias": "<string>",
			"createdAt": "<string>",
			"homepageId": "<string>",
			"description": {
				"plain": {},
				"view": {}
			},
			"icon": {
				"path": "<string>",
				"apiDownloadLink": "<string>"
			},
			"_links": {
				"webui": "<string>"
			}
		}
	],
	"_links": {
		"next": "<string>",
		"base": "<string>"
	}
}