Actions35
- 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
Overview
The "Get Page By Id" operation in the Confluence Cloud node allows you to retrieve detailed information about a specific Confluence page by providing its unique ID. This operation is useful when you need to fetch the content and metadata of a particular page, for example, to display it in an application, analyze its content, or use it as part of an automation workflow.
Common scenarios include:
- Fetching a page's content to display or process it elsewhere.
- Retrieving page metadata such as labels, versions, collaborators, or likes.
- Accessing draft or historical versions of a page.
- Including related data like child pages or web resources for rendering.
Practical example:
- An automation that retrieves a page by ID and sends its content via email.
- A workflow that checks if a page has been favorited by the current user before performing further actions.
- Extracting all labels and collaborators associated with a page for reporting purposes.
Properties
Name | Meaning |
---|---|
Id | The unique numeric ID of the page to be retrieved. Required. |
Body Format | The content format types to be returned in the body field of the response. If available, the representation will be under a response field of the same name inside the body . |
Get Draft | Boolean flag to retrieve the draft version of the page instead of the published one. |
Status | Filter the page by its status. Possible values: Current, Archived, Trashed, Deleted, Historical, Draft. |
Version | Retrieve a previously published version by specifying its version number. |
Include Labels | Include labels associated with the page in the response. Limited to 50 results with pagination info. |
Include Properties | Include content properties associated with the page in the response. Limited to 50 results with pagination info. |
Include Operations | Include operations associated with the page in the response, as defined in the Operation object. Limited to 50 results with pagination info. |
Include Likes | Include likes associated with the page in the response. Limited to 50 results with pagination info. |
Include Versions | Include versions associated with the page in the response. Limited to 50 results with pagination info. |
Include Version | Include the current version associated with the page in the response. Included by default; can be omitted by setting to false. |
Include Favorited By Current User Status | Include whether the page has been favorited by the current user. |
Include Webresources | Include web resources that can be used to render page content on a client. |
Include Collaborators | Include collaborators on the page. |
Include Direct Children | Include direct children of the page, as defined in the ChildrenResponse object. |
Output
The output JSON contains detailed information about the requested Confluence page, including:
- Basic page metadata (ID, title, status, etc.).
- The page content in various formats depending on the
Body Format
property. - Optional included data such as labels, properties, operations, likes, versions, collaborators, and web resources, based on the selected additional fields.
- Pagination metadata (
meta
and_links
) when including collections like labels or versions, indicating if more results are available. - Information about whether the page is favorited by the current user if requested.
No binary data output is indicated for this operation.
Dependencies
- Requires an API authentication token credential configured in n8n to access the Confluence Cloud REST API.
- The node uses the base URL from the user's credentials domain configuration.
- Permissions required: The authenticated user must have permission to view the specified page and its corresponding space in Confluence.
Troubleshooting
- Invalid or missing page ID: Ensure the
Id
property is set correctly to a valid numeric page ID. Use the "Get Pages" operation to find IDs if unknown. - Permission errors: The user must have view permissions for the page and its space. Errors related to authorization indicate insufficient permissions.
- Status filtering issues: If no page is returned, verify the
Status
filter matches the actual page status. - Version retrieval problems: When specifying a version number, ensure it exists; otherwise, the request may fail or return no data.
- API rate limits: Large requests or frequent calls might hit API rate limits; consider adding delays or handling retries.
- Pagination limits: When including collections (labels, versions, etc.), only up to 50 items are returned per request. Use pagination links if needed.