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 Inline Comments" operation of the Comment resource in this Confluence Cloud node retrieves all inline comments from Confluence. Inline comments are comments attached directly to specific parts of page or blog post content, often used for detailed feedback or discussions tied to particular text segments.
This operation is useful when you want to programmatically fetch all inline comments across your Confluence instance, for example:
- To audit or review all inline feedback on documentation pages.
- To aggregate inline comments for reporting or analytics.
- To synchronize inline comment data with other tools or workflows.
The results are paginated and can be sorted or filtered by various criteria such as body format or sort order.
Properties
| Name | Meaning |
|---|---|
| Additional Fields | A collection of optional parameters to customize the request: |
| - Body Format | The content format type to be returned in the body field of each comment (e.g., storage, view). |
| - Sort | Field name to sort the results by (e.g., creation date, author). |
These properties allow you to control how the inline comments are retrieved and presented.
Output
The output JSON contains a list of inline comments under a root property named results. Each item represents an inline comment object with details such as:
- Comment content in the specified body format.
- Metadata about the comment (author, creation date, status).
- Possibly nested replies if supported by the API.
- Pagination information via HTTP Link headers for fetching additional pages.
No binary data is involved in this operation.
Dependencies
- Requires an authenticated connection to a Confluence Cloud instance using an API key credential.
- The node uses the Confluence Cloud REST API v2 endpoints.
- Proper permissions are required to view the content and its inline comments.
Troubleshooting
- Permission errors: Ensure the API key has permission to view the content and comments in Confluence.
- Empty results: Verify that inline comments exist and that any filters (like body format or sort) are correctly set.
- Pagination issues: If not all comments are returned, use pagination links provided in response headers to fetch subsequent pages.
- Invalid body format: Use valid content format types supported by Confluence; otherwise, the API may return errors or default formats.