Confluence Cloud icon

Confluence Cloud

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

Overview

The "Get Space Labels" operation in the Confluence Cloud node retrieves labels associated with a specific Confluence space. Labels are metadata tags that help categorize and organize content within Confluence spaces. This operation is useful for users who want to list or filter labels applied to a particular space, enabling better content management and searchability.

Common scenarios include:

  • Fetching all labels used in a space to understand tagging conventions.
  • Filtering labels by prefix or sorting them to display organized label lists.
  • Integrating label data into workflows that automate content categorization or reporting.

Example: A user wants to get all labels starting with "team" in a project space to generate a report on team-related content tags.

Properties

Name Meaning
Id The ID of the space for which labels should be returned.
Return All Whether to return all results or only up to a given limit.
Limit Maximum number of results to return (API limit: 250).
Additional Fields Optional filters and sorting options:
- Prefix: Filter labels by prefix ("My", "Team").
- Sort: Sort results by a specified field.

Output

The output JSON contains a list of label objects under the results property. Each label object represents a label associated with the specified space. The number of labels returned respects the limit or returnAll settings.

If more labels exist beyond the limit, pagination links may be provided in response headers (not shown here).

No binary data is output by this operation.

Dependencies

  • Requires an authenticated connection to Confluence Cloud via an API key credential.
  • The node must be configured with the Confluence Cloud domain URL and valid credentials.
  • User permissions: The authenticated user must have permission to view the specified space and its labels.

Troubleshooting

  • Permission errors: If the user lacks permission to view the space, the API will deny access. Ensure the user has at least view rights on the space.
  • Invalid space ID: Providing a non-existent or incorrect space ID will result in no labels or an error. Verify the space ID is correct.
  • Limit exceeded: The API limits results to 250 per request. Use "Return All" to paginate through all labels.
  • Prefix filtering: Using an invalid prefix option may return empty results. Use one of the allowed prefixes ("My", "Team") or omit to get all labels.

Links and References


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

Discussion