Get spaces

GET {{baseUrl}}/api/space?spaceKey=<string>&spaceKey=<string>&spaceId=<long>&spaceId=<long>&type=<string>&status=<string>&label=<string>&label=<string>&favourite=<boolean>&favouriteUserKey=<string>&expand=<string>&expand=<string>&start=0&limit=25

Returns all spaces. The returned spaces are ordered alphabetically in ascending order by space key.

Permissions required: Permission to access the Confluence site ('Can use' global permission). Note, the returned list will only contain spaces that the current user has permission to view.

Request Params

Leave blank for the current user. Use Get user to get the userKey for a user. | | expand | string | | A multi-value parameter indicating which properties of the spaces to expand, where:

• settings returns the settings for the space, similar to Get space settings.

• metadata.labels returns the space labels, which are used to categorize the space.

• operations returns the operations for a space, which are used when setting permissions.

• lookAndFeel returns information about the look and feel of the space, including the color scheme.

• permissions returns the permissions for the space. Note that this may return permissions for deleted groups, because deleting a group doesn't remove associated space permissions.

• icon returns information about space icon.

• description.plain returns the description of the space.

• description.view returns the description of the space.

• theme returns information about the space theme.

• homepage returns information about the space homepage. | | expand | string | | A multi-value parameter indicating which properties of the spaces to expand, where:

• settings returns the settings for the space, similar to Get space settings.

• metadata.labels returns the space labels, which are used to categorize the space.

• operations returns the operations for a space, which are used when setting permissions.

• lookAndFeel returns information about the look and feel of the space, including the color scheme.

• permissions returns the permissions for the space. Note that this may return permissions for deleted groups, because deleting a group doesn't remove associated space permissions.

• icon returns information about space icon.

• description.plain returns the description of the space.

• description.view returns the description of the space.

• theme returns information about the space theme.

• homepage returns information about the space homepage. | | start | number | | The starting index of the returned spaces. | | limit | number | | The maximum number of spaces to return per page. Note, this may be restricted by fixed system limits. |

RESPONSES

status: OK

{"results":[{"id":26764331,"key":"laborum","name":"in adipisicing nisi","type":"sunt","status":"laborum voluptate","_expandable":{"settings":"sit occaecat","metadata":"","operations":"sunt do culpa ullamco","lookAndFeel":"Lorem occaecat","permissions":"cupidatat dolore elit et","icon":"occaecat Excepteur","description":"consectetur id Excepteur mollit","theme":"volupt","history":"est laboris adipisicing occaecat non","homepage":"in laboris"},"_links":{},"icon":{"path":"irure ut","width":74794118,"height":55813977,"isDefault":false},"description":{"plain":{"value":"Lorem","representation":"plain","embeddedContent":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]},"view":{"value":"officia sunt velit","representation":"plain","embeddedContent":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]}},"homepage":{"value":"\u003cCircular reference to #/components/schemas/Content detected\u003e"},"metadata":{"labels":{"results":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"start":-83054779,"limit":97968975,"size":-70611604,"_links":{}}},"operations":[{"operation":"copy","targetType":"blogpost"},{"operation":"update","targetType":"blogpost"}],"permissions":[{"subjects":{"_expandable":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"group":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"operation":{"operation":"administer","targetType":"application"},"anonymousAccess":false,"unlicensedAccess":false},{"subjects":{"_expandable":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"group":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"operation":{"operation":"move","targetType":"comment"},"anonymousAccess":false,"unlicensedAccess":false}],"settings":{"routeOverrideEnabled":false,"_links":{}},"theme":{},"lookAndFeel":{"headings":{"color":"\u003cstring\u003e"},"links":{"color":"\u003cstring\u003e"},"menus":{"hoverOrFocus":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"color":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"header":{"backgroundColor":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"button":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"primaryNavigation":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"secondaryNavigation":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"search":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"content":{"screen":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"container":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"header":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"body":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"bordersAndDividers":{"color":"\u003cstring\u003e"}},"history":{"createdDate":"1999-07-22T04:19:16.365Z"}},{"id":-19509015,"key":"tempor veniam commodo aute pariatur","name":"id velit ex sit","type":"quis officia cillum","status":"officia ipsum proident irure culpa","_expandable":{"settings":"aute non","metadata":"laborum do deserunt","operations":"Duis occaecat Excepteur","lookAndFeel":"esse","permissions":"mollit id in Excepteur","icon":"elit velit m","description":"magna ipsum dolor nisi","theme":"cupidatat ex ","history":"ipsum esse","homepage":"ipsum commodo officia"},"_links":{},"icon":{"path":"occaecat enim mollit","width":28738893,"height":88604543,"isDefault":true},"description":{"plain":{"value":"amet Excepteur aliquip qui","representation":"plain","embeddedContent":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]},"view":{"value":"in tempor","representation":"plain","embeddedContent":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]}},"homepage":{"value":"\u003cCircular reference to #/components/schemas/Content detected\u003e"},"metadata":{"labels":{"results":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"start":33084561,"limit":-91985267,"size":-56212284,"_links":{}}},"operations":[{"operation":"move","targetType":"space"},{"operation":"administer","targetType":"space"}],"permissions":[{"subjects":{"_expandable":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"group":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"operation":{"operation":"restore","targetType":"attachment"},"anonymousAccess":false,"unlicensedAccess":false},{"subjects":{"_expandable":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"group":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"operation":{"operation":"purge","targetType":"blogpost"},"anonymousAccess":false,"unlicensedAccess":false}],"settings":{"routeOverrideEnabled":false,"_links":{}},"theme":{},"lookAndFeel":{"headings":{"color":"\u003cstring\u003e"},"links":{"color":"\u003cstring\u003e"},"menus":{"hoverOrFocus":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"color":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"header":{"backgroundColor":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"button":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"primaryNavigation":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"secondaryNavigation":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"search":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"content":{"screen":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"container":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"header":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"body":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"bordersAndDividers":{"color":"\u003cstring\u003e"}},"history":{"createdDate":"1988-11-10T03:26:30.943Z"}}],"start":-704604,"limit":17139756,"size":86679250,"_links":{}}