Confluence Cloud icon

Confluence Cloud

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

Actions43

Overview

This node operation retrieves comments associated with a specific custom content item in Confluence Cloud. It is useful when you want to fetch all footer comments made on a particular piece of custom content, such as feedback or discussion notes related to that content.

Typical use cases include:

  • Aggregating user comments for review or moderation.
  • Displaying comment threads related to custom content in external dashboards or applications.
  • Automating workflows based on comment activity on custom content.

For example, if you have a custom content item representing a project document, this operation can fetch all comments users have left on it, enabling integration with other tools or reporting systems.

Properties

Name Meaning
Id The ID of the custom content for which comments should be returned.
Additional Fields Optional extra parameters:
- Body Format: The format type for the comment body content (e.g., storage, view).
- Sort: Field by which to sort the returned comments.

Output

The output is a JSON array of comment objects corresponding to the footer comments on the specified custom content. Each comment object includes details such as the comment's body, author, creation date, and potentially other metadata depending on the API response.

If the "Body Format" option is used, the comment body may include different representations under the body field.

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.
  • Permissions: The user must have permission to view the custom content and its containers to retrieve comments.

Troubleshooting

  • Permission errors: If the node returns authorization errors, verify that the API key has sufficient permissions to access the custom content and read comments.
  • Invalid ID: Providing an incorrect or non-existent custom content ID will result in no comments or an error. Ensure the ID is correct.
  • Empty results: If no comments are returned, confirm that the custom content actually has comments and that filters (like status or sort) are not excluding them.
  • API limits: The Confluence API limits the number of results per request; use pagination or the "Return All" option if available to fetch more comments.

Links and References

Discussion