Actions43
- 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
- Label Actions
Overview
The "Get Labels" operation of the Confluence Cloud node retrieves a list of labels from the Confluence Cloud REST API. Labels are tags or keywords that can be attached to various Confluence content types (pages, blog posts, attachments, spaces, etc.) to categorize and organize them.
This operation is useful when you want to:
- Fetch all available labels in your Confluence instance.
- Filter labels by specific criteria such as label IDs or prefixes.
- Retrieve labels for reporting, filtering, or automation purposes.
Practical examples:
- Automatically fetching all labels to build a tag cloud or filter UI.
- Retrieving labels with a certain prefix to identify team-specific or project-specific tags.
- Limiting the number of labels returned to optimize performance in workflows.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all results or only up to a given limit. |
| Limit | Maximum number of results to return (maximum 250 due to Confluence API limits). |
| Additional Fields | Optional filters and sorting options: |
| - Label Id | Filter labels by one or more label IDs (comma-separated list). |
| - Prefix | Filter labels by one or more label prefixes (comma-separated list). |
| - Sort | Sort the result by a particular field (e.g., alphabetical order). |
Output
The output JSON contains a property named results which holds an array of label objects retrieved from Confluence. Each label object typically includes details such as the label's ID, name, and possibly other metadata depending on the API response.
If the "Return All" option is enabled, the node will paginate through all available labels up to the API maximum or until no more results are available.
No binary data is output by this operation.
Dependencies
- Requires an authenticated connection to Confluence Cloud via an API key credential.
- The node uses the Confluence Cloud REST API endpoint
/wiki/api/v2/labels. - The user must have permission to access the Confluence site ("Can use" global permission) to retrieve labels.
Troubleshooting
Common issues:
- Exceeding the API limit of 250 results per request without enabling "Return All" may cause incomplete data retrieval.
- Insufficient permissions will result in authorization errors; ensure the API key has appropriate access rights.
- Incorrect or malformed filter values (e.g., invalid label IDs or prefixes) may lead to empty results or errors.
Error messages:
- 401 Unauthorized: Check that the API key credential is valid and has necessary permissions.
- 403 Forbidden: The user does not have permission to view labels; verify user roles and permissions.
- 400 Bad Request: Invalid query parameters; review filter inputs like label IDs and prefixes.