Confluence Cloud icon

Confluence Cloud

Zugriff auf die Confluence Cloud REST API - Auto-generated from OpenAPI

Overview

This node operation retrieves the root inline comments for a specific Confluence page. Inline comments are comments attached directly to specific parts of the page content, often used for detailed feedback or discussions on particular text segments.

Typical use cases include:

  • Extracting all inline comments from a page to review feedback or discussion points.
  • Automating the collection of inline comments for reporting or analysis.
  • Integrating Confluence inline comments into other workflows or systems for collaboration tracking.

For example, a team lead might use this node to gather all inline comments on a project documentation page to summarize feedback before a meeting.

Properties

Name Meaning
Id The ID of the page for which inline comments should be returned. This is a required numeric identifier specifying the target page.
Additional Fields Optional additional parameters to refine the request:
- Body Format: The content format type to be returned in the body field of each comment (e.g., storage, view).
- Status: Filter inline comments by their status. Possible values: Current, Archived, Trashed, Deleted, Historical, Draft.
- Resolution Status: Filter inline comments by resolution status. Possible values: Resolved, Open, Dangling, Reopened.
- Sort: Specify a field to sort the results by.

Output

The output JSON contains an array of inline comment objects corresponding to the specified page. Each comment object includes details such as:

  • Comment content in the requested body format.
  • Metadata about the comment's status and resolution state.
  • Identifiers linking the comment to specific parts of the page content.

If multiple comments exist, pagination may apply depending on the API response and limits.

No binary data output is involved in this operation.

Dependencies

  • Requires access to a Confluence Cloud instance with appropriate permissions to view the page and its comments.
  • An API authentication token or API key credential configured in n8n to authorize requests to the Confluence Cloud REST API.
  • The node uses the Confluence Cloud REST API endpoint /wiki/api/v2/pages/{id}/inline-comments.

Troubleshooting

  • Permission Errors: If the node returns permission-related errors, ensure that the API credentials have sufficient rights to view the target page and its comments.
  • Invalid Page ID: Providing an incorrect or non-existent page ID will result in errors or empty responses. Verify the page ID before running the node.
  • Empty Results: If no inline comments are returned, confirm that the page actually has inline comments and that filters (status, resolution status) are not excluding all results.
  • API Rate Limits: Large numbers of comments or frequent requests may hit API rate limits; consider using pagination or limiting the number of results.

Links and References

Discussion