Actions35
- Space Actions
- Page Actions
- Template Actions
- Search Actions
- Comment Actions
- Get Page Footer Comments
- Get Page Inline Comments
- Get Blog Post Footer Comments
- Get Blog Post Inline Comments
- Get Custom Content Comments
- Get Footer Comments
- Create Footer Comment
- Get Footer Comment By Id
- Update Footer Comment
- Delete Footer Comment
- Get Footer Comment Children
- Get Inline Comments
- Create Inline Comment
- Get Inline Comment By Id
- Update Inline Comment
- Delete Inline Comment
- Get Inline Comment Children
Overview
The "Get Spaces" operation of the Confluence Cloud node retrieves a list of spaces from a Confluence Cloud instance. It allows users to fetch multiple spaces with various filtering and sorting options, such as filtering by space IDs, keys, type, status, labels, and user favorites. This operation is useful for scenarios where you want to list or analyze spaces available in your Confluence site, automate documentation workflows, or integrate space metadata into other systems.
Practical examples include:
- Fetching all active collaboration spaces to generate reports.
- Retrieving specific spaces by their keys or IDs for synchronization with external tools.
- Filtering spaces favorited by a particular user to customize dashboards or notifications.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all matching spaces or limit the number of results. |
| Limit | Maximum number of spaces to return when not returning all (max 250). |
| Additional Fields | A collection of optional filters and parameters: - Ids: Comma-separated list of space IDs to filter. - Keys: Comma-separated list of space keys to filter. - Type: Filter by space type (Global, Collaboration, Knowledge Base, Personal). - Status: Filter by space status (Current, Archived). - Labels: Comma-separated list of labels to filter. - Favorited By: Account ID of user who favorited the space. - Not Favorited By: Account ID of user who has not favorited the space. - Sort: Field to sort the results by. - Description Format: Content format type for the description field. - Include Icon: Whether to fetch the icon for the space (boolean). |
Output
The output JSON contains a property named results which is an array of space objects. Each space object includes details about the space such as its ID, key, name, type, status, description, labels, and optionally its icon if requested.
The node supports pagination internally when "Return All" is enabled, fetching up to the API limit of 250 per request and aggregating results.
No binary data output is involved in this operation.
Dependencies
- Requires an authenticated connection to a Confluence Cloud instance via an API key credential.
- The node uses the Confluence Cloud REST API v2 endpoint
/wiki/api/v2/spaces. - Proper permissions are required on the Confluence site: the user must have the global "Can use" permission and view permissions for the spaces being queried.
Troubleshooting
- Permission Errors: If the node returns permission errors, ensure the API key used has sufficient rights to access the Confluence site and the spaces.
- Limit Exceeded: The API limits the maximum number of results per request to 250. Use the "Return All" option to paginate through all results.
- Invalid Filters: Providing invalid space IDs, keys, or unsupported filter values may result in empty responses or errors.
- Network Issues: Connectivity problems or incorrect base URL configuration can cause request failures.
Links and References
- Confluence Cloud REST API - Get Spaces
- Confluence Permissions Overview
- Confluence Query Language (CQL) (for advanced filtering concepts)