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
This node operation retrieves labels associated with a specific piece of custom content in Confluence Cloud. Labels are metadata tags that help categorize and organize content, making it easier to search and filter within Confluence. This operation is useful when you want to programmatically access the labels applied to custom content items, for example, to analyze tagging patterns, automate workflows based on labels, or synchronize label data with other systems.
Practical examples:
- Fetch all labels for a custom content item to display them in an external dashboard.
- Use labels to trigger automation when certain tags appear on custom content.
- Audit labeling consistency across custom content in your Confluence instance.
Properties
| Name | Meaning |
|---|---|
| Id | The ID of the custom content for which labels should be returned. |
| Return All | Whether to return all results or only up to a given limit. |
| Limit | Max number of results to return (Confluence API limit: 250). Used only if "Return All" is false. |
| Additional Fields | Optional filters and sorting options: - Prefix: Filter labels by prefix; options: My, Team, Global, System. - 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 applied to the specified custom content. The structure typically includes label details such as name, prefix, and possibly other metadata depending on the Confluence API response.
If the result set is large and "Return All" is enabled, the node will paginate through all available labels up to the API limits.
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/custom-content/{id}/labels. - Proper permissions are required to view the custom content and its labels.
Troubleshooting
- Permission errors: If the user lacks permission to view the custom content or its labels, the API will return an authorization error. Ensure the API key has sufficient rights.
- Invalid ID: Providing an incorrect or non-existent custom content ID will result in a "not found" error. Verify the ID before use.
- Limit exceeded: The API enforces a maximum limit of 250 labels per request. Use "Return All" to fetch more, but be mindful of rate limits.
- Network issues: Connectivity problems can cause request failures. Check network settings and API availability.