Confluence Cloud

Access to the Confluence Cloud REST API - Auto-generated from OpenAPI

Actions43

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.

Typical use cases include:

Displaying or processing information about a specific space in automation workflows.
Integrating Confluence space data into other systems or dashboards.
Verifying space properties or permissions programmatically.

For example, you might use this operation to get the description, icon, permissions, or labels associated with a space before performing further actions like content creation or reporting.

Properties

Name	Meaning
Id	The unique numeric identifier of the space to be retrieved. This is required.
Additional Fields	A collection of optional parameters to customize the response:
- Description Format	Specifies the format type for the `description` field in the response (e.g., storage, view). If provided, 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. Results are limited to 50 and sorted by default. Metadata and links indicate if more results are available.
- 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 specified Confluence space. This includes standard space metadata such as its ID, key, name, description, and optionally:

The space icon (if requested).
Associated operations, properties, permissions, role assignments, and labels (if requested via additional fields).

The structure follows the Confluence Cloud REST API v2 format for spaces, providing nested objects and arrays for included related data. 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 base URL for API requests is configured from the user's credentials (the Confluence domain).
Proper permissions are needed to view the space; otherwise, the API will return an authorization error.

Troubleshooting

Common Issues:
- Invalid or missing space ID: Ensure the Id property is set correctly and corresponds to an existing space.
- Insufficient permissions: The user must have permission to view the space; otherwise, access will be denied.
- Network or authentication errors: Verify that the API key credential is valid and the domain URL is correct.
Error Messages:
- 404 Not Found: The specified space ID does not exist or is inaccessible.
- 401 Unauthorized / 403 Forbidden: Authentication failed or the user lacks permission to view the space.
- 400 Bad Request: Invalid query parameters, e.g., unsupported description format.

Resolving these typically involves verifying input parameters, checking user permissions in Confluence, and ensuring correct API credentials.