Confluence V2 icon

Confluence V2

Interact with Confluence using API v2

Actions3

Get Pages in Space

AI-generated

Overview

This node interacts with Confluence API v2 to retrieve information about pages within a specified Confluence space. It supports operations to get a flat list of pages in a space, optionally including their hierarchical children, or to get the full page hierarchy structure. This is useful for users who want to automate the retrieval of Confluence content for documentation, reporting, or integration with other systems.

Use Case Examples

  1. Fetch all pages in a Confluence space by providing the space ID.
  2. Retrieve pages along with their child pages up to a specified depth to understand the page hierarchy.
  3. Get the full hierarchical structure of pages in a space for visualization or export.

Properties

Name Meaning
Space ID The ID of the Confluence space to fetch pages from. Required for page retrieval operations.
Include Hierarchy Boolean flag to indicate whether to fetch child pages for each page when getting pages in a space.
Depth Control Controls how deep the page hierarchy is fetched. Options are 'Full Depth' (no limit) or 'Max Depth' (limited depth).
Max Depth Maximum depth to fetch in the page hierarchy when depth control is set to limited. 1 means only direct children are fetched.
Limit Maximum number of pages to return per request, with a range from 1 to 250.

Output

JSON

  • json
    • error - Error message if the operation fails and continueOnFail is enabled.

Dependencies

  • Confluence API v2

Troubleshooting

  • Common issues include invalid or missing Space ID, which will cause the API call to fail.
  • If the limit is set too high, the request might time out or be rejected by the API.
  • When fetching hierarchy, setting a very high depth may result in long execution times or large data volumes.
  • Error messages from the API are returned in the output if continueOnFail is enabled, allowing the workflow to continue despite errors.

Discussion