Confluence Cloud icon

Confluence Cloud

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

Actions43

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, such as for displaying, processing, or integrating with other systems.

Common scenarios include:

  • Fetching a page's content to display it in an external application.
  • Retrieving page metadata for reporting or auditing purposes.
  • Accessing different versions or drafts of a page for review or comparison.

For example, you might use this operation to get the current published version of a page, include its labels and collaborators, or retrieve a draft version for editing workflows.

Properties

Name Meaning
Id The unique numeric ID of the page to be retrieved. If unknown, you can use the "Get pages" operation to find it.
Body Format The format type(s) of the page content to return in the body field (e.g., storage, view). The response will include the content representation under the specified format name within the body field if available.
Get Draft Whether 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 specific previously published version of the page by specifying its version number.
Include Labels Include labels associated with the page in the response. Results are limited to 50 and sorted by default. Pagination info is provided if more results exist.
Include Properties Include content properties associated with the page in the response. Limited to 50 results with pagination info if applicable.
Include Operations Include operations associated with the page, describing permissions or actions available. Limited to 50 results with pagination info.
Include Likes Include likes associated with the page. Limited to 50 results with pagination info.
Include Versions Include all versions associated with the page. Limited to 50 results with pagination info.
Include Version Include the current version of the page. Included by default; can be omitted by setting to false.
Include Favorited By Current User Status Include whether the current user has favorited the page.
Include Webresources Include web resources that help render the page content on clients.
Include Collaborators Include collaborators on the page.
Include Direct Children Include direct child pages of the page, as defined in the ChildrenResponse object.

Output

The output JSON contains detailed information about the requested Confluence page. This includes:

  • Basic page metadata such as ID, title, status, and version.
  • The body field containing the page content in the requested format(s).
  • Optional included data depending on selected flags, such as:
    • Labels attached to the page.
    • Content properties.
    • Operations (permissions/actions).
    • Likes.
    • Versions history.
    • Current version details.
    • Favorited status by the current user.
    • Web resources for rendering.
    • Collaborators on the page.
    • Direct child pages.

The structure follows the Confluence Cloud REST API v2 conventions, with nested objects representing these aspects.

This node does not output binary data.

Dependencies

  • Requires access to a Confluence Cloud instance via its REST API.
  • Requires an API authentication credential configured in n8n to authorize requests.
  • The base URL for API requests is derived from the user's Confluence domain credential.

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 unsure.
  • Permission errors: The authenticated user must have permission to view the page and its space. Errors related to authorization indicate insufficient permissions.
  • Status filtering issues: If filtering by status yields no results, verify the page's actual status in Confluence.
  • Version retrieval problems: Specifying a non-existent version number will result in an error. Confirm the version exists.
  • API rate limits: Excessive requests may trigger rate limiting by Confluence Cloud. Implement retries or backoff strategies if needed.
  • Incorrect body format: Requesting unsupported body formats may cause incomplete or empty content fields.

Links and References

Discussion