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 Space By Id" operation in this Confluence Cloud node retrieves detailed information about a specific Confluence space by its unique ID. This operation is useful when you need to fetch metadata and configuration details of a particular space within your Confluence instance.
Common scenarios include:
- Fetching space details for reporting or auditing purposes.
- Retrieving space metadata before performing updates or content operations.
- Integrating Confluence space data into other workflows or systems.
For example, you might use this operation to get the description, icon, permissions, labels, or role assignments of a space identified by its ID, enabling automated management or synchronization tasks.
Properties
| Name | Meaning |
|---|---|
| Id | The unique numeric ID of the space to be returned. This is required to specify which space's details to fetch. |
| Additional Fields | A collection of optional parameters to customize the response: |
| - Description Format | The format type for the description field in the response (e.g., storage, view). If specified, the description will include a representation in this format. |
| - Include Icon | Boolean flag indicating whether to include the space's icon in the response. |
| - Include Operations | Boolean flag to include operations associated with the space, limited to 50 results, with pagination info. |
| - Include Properties | Boolean flag to include space properties associated with the space, limited to 50 results, with pagination info. |
| - Include Permissions | Boolean flag to include permissions associated with the space, limited to 50 results, with pagination info. |
| - Include Role Assignments | Boolean flag to include role assignments associated with the space (only accepted for Early Access Program sites), limited to 50 results, with pagination info. |
| - Include Labels | Boolean flag to include labels associated with the space, limited to 50 results, with pagination info. |
Output
The output JSON contains detailed information about the requested Confluence space. This includes standard space metadata such as:
- Space ID, key, name, and type.
- Description in the default and optionally specified formats.
- Icon data if requested.
- Lists of operations, properties, permissions, role assignments, and labels if their respective flags are enabled.
- Pagination metadata (
meta) and links (_links) when including collections like operations or labels.
This rich data structure allows downstream nodes or processes to utilize comprehensive space information for further automation or integration.
Dependencies
- Requires an authenticated connection to a Confluence Cloud instance via an API key credential.
- The node expects the base URL of the Confluence Cloud domain to be configured in the credentials.
- Proper permissions on the Confluence site are necessary to view the space and any included related data (operations, permissions, etc.).
Troubleshooting
- Permission Errors: If the user lacks permission to view the space, the API will return an authorization error. Ensure the API key has sufficient rights.
- Invalid Space ID: Providing a non-existent or incorrect space ID will result in a "not found" error. Verify the ID before making the request.
- Exceeding Limits: Including large collections (like operations or labels) may be limited to 50 items per response. Use pagination if more data is needed.
- Incorrect Additional Fields: Misconfigured additional fields (e.g., invalid description format) may cause unexpected responses or errors. Validate input values against Confluence API documentation.