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 Label Pages" operation in the Confluence Cloud node retrieves pages that are tagged with a specific label ID. This is useful when you want to filter and fetch all pages associated with a particular label, helping organize or find content based on tagging within Confluence.
Common scenarios include:
- Gathering all documentation pages related to a project or topic labeled accordingly.
- Automating reports or exports of pages grouped by labels.
- Integrating with other systems where content categorization by labels is important.
For example, if you have a label "release-notes" applied to multiple pages, this operation can fetch all those pages for further processing or display.
Properties
| Name | Meaning |
|---|---|
| Id | The ID of the label for which pages should be returned. |
| Return All | Whether to return all results or only up to a given limit. |
| Limit | Maximum number of results to return (max 250 as per Confluence API limit). |
| Additional Fields | Optional filters including: |
| - Space Id | Filter results by space IDs (comma-separated list). |
| - Body Format | Specify content format types to be returned in the body field of each page's response. |
| - Sort | Field used to sort the result set. |
Output
The output JSON contains a property named results, which is an array of page objects matching the specified label. Each page object includes details about the page such as its ID, title, content body (in requested formats), metadata, and other relevant information provided by the Confluence API.
If the user opts to return all results, the node handles pagination internally to fetch all pages; otherwise, it returns up to the specified limit.
No binary data output is involved in 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/{id}/pages. - Proper permissions are required to view the content of the pages and their corresponding spaces.
Troubleshooting
- Permission Errors: If the node returns permission-related errors, ensure the API key has sufficient rights to view the pages and spaces associated with the label.
- Invalid Label ID: Providing a non-existent or incorrect label ID will result in no results or errors. Verify the label ID before use.
- Limit Exceeded: The Confluence API limits the maximum number of results per request to 250. Use the "Return All" option to fetch more than 250 pages.
- Network Issues: Connectivity problems with the Confluence instance or incorrect domain configuration may cause request failures.