Confluence Cloud icon

Confluence Cloud

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

Actions43

Overview

The "Get Spaces" operation in 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, making it useful for scenarios where you need to manage or analyze spaces within a Confluence site.

Common use cases include:

  • Listing all accessible spaces for reporting or auditing.
  • Filtering spaces by type (e.g., global, collaboration) or status (current or archived).
  • Retrieving specific spaces by their IDs or keys.
  • Sorting spaces based on custom criteria.
  • Including additional metadata such as icons or descriptions in different formats.

For example, a user might want to get all active collaboration spaces that they have access to, or retrieve a limited number of spaces sorted by name for display in a dashboard.

Properties

Name Meaning
Return All Whether to return all available spaces or limit the results to a specified maximum number.
Limit Maximum number of spaces to return when not returning all. The API limit is 250.
Additional Fields A collection of optional filters and parameters to refine the query:
- Ids Filter spaces by their IDs; multiple IDs can be comma-separated.
- Keys Filter spaces by their keys; multiple keys can be comma-separated.
- Type Filter spaces by type. Options: Global, Collaboration, Knowledge Base, Personal.
- Status Filter spaces by status. Options: Current, Archived.
- Labels Filter spaces by labels; multiple labels can be comma-separated.
- Favorited By Filter spaces favorited by a user with the specified account ID.
- Not Favorited By Filter spaces NOT favorited by a user with the specified account ID.
- Sort Sort the results by a particular field (string).
- Description Format Specify the content format type for the description field in the response.
- Include Icon Boolean flag indicating whether to fetch the icon for each space.

Output

The output JSON contains a property named results, which is an array of space objects matching the query criteria. Each space object includes details such as its ID, key, name, type, status, description, and optionally an icon if requested.

If the "Return All" option is false, the number of returned spaces is limited by the "Limit" property (up to 250). Pagination information may be available via HTTP headers but is handled internally by the node.

No binary data is output by this operation.

Dependencies

  • Requires connection to a Confluence Cloud instance.
  • Requires an API authentication token credential configured in n8n to authorize requests.
  • The base URL for API requests is derived from the user's Confluence domain credential.
  • Permissions required: The user must have permission to access the Confluence site ("Can use" global permission) and view the spaces.

Troubleshooting

  • Permission Errors: If the node returns authorization errors, verify that the API token has sufficient permissions and that the user can access the Confluence site and 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 IDs, keys, or other filter values may result in empty responses or errors. Double-check filter inputs.
  • Network Issues: Ensure the Confluence domain is reachable and the API endpoint /wiki/api/v2/spaces is accessible.
  • Include Icon Flag: Setting "Include Icon" to true may increase response size and latency; use only if needed.

Links and References

This summary is based on static analysis of the node's properties and routing configuration for the "Get Spaces" operation under the "Space" resource.

Discussion