Confluence Cloud icon

Confluence Cloud

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

Actions43

Overview

The "Get Page Labels" operation in the Confluence Cloud node retrieves labels associated with a specific Confluence page. This is useful for scenarios where you want to programmatically access metadata tags (labels) assigned to a page, which can help in categorizing, filtering, or managing content within Confluence.

Practical examples include:

  • Fetching all labels of a page to display or process them in an external system.
  • Automating content organization by analyzing page labels.
  • Integrating label data into workflows that depend on page categorization.

Properties

Name Meaning
Id The ID of the page 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 (Confluence API limit: 250).
Additional Fields Optional filters and sorting options:
- Prefix: Filter labels by prefix ("My", "Team", "Global", "System").
- Sort: Sort the results by a specified field.

Output

The output JSON contains a list of label objects associated with the specified page. The main data is under the results property, which holds an array of labels. Each label typically includes properties such as its name and possibly other metadata depending on the Confluence API response.

If the "Return All" option is enabled, the node will fetch all available labels; otherwise, it limits the number of labels returned according to the "Limit" property.

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/pages/{id}/labels.
  • Proper permissions are required to view the page and its labels.

Troubleshooting

  • Common Issues:

    • Invalid or missing page ID: Ensure the "Id" property is set correctly to a valid page ID.
    • Insufficient permissions: The user must have permission to view the page and its labels.
    • API rate limits: If many requests are made rapidly, the Confluence API may throttle requests.

  • Error Messages:

    • 404 Not Found: The specified page ID does not exist or is inaccessible.
    • 401 Unauthorized / 403 Forbidden: Authentication failed or insufficient permissions.
    • 400 Bad Request: Invalid parameters, e.g., invalid prefix or limit values.

  • Resolutions:

    • Verify the page ID and ensure it exists.
    • Check API credentials and permissions.
    • Adjust request frequency to avoid hitting rate limits.
    • Validate input parameters against allowed values.

Links and References

Discussion