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 Pages In Space" operation of the Confluence Cloud node retrieves pages within a specified Confluence space. It allows users to fetch multiple pages from a given space, with options to filter and sort the results based on various criteria such as page status, title, depth in the page hierarchy, and content body format.
This operation is beneficial when you want to:
- List all or a subset of pages within a particular Confluence space.
- Filter pages by their status (e.g., current, archived).
- Retrieve pages at different levels of the space hierarchy (root level or all pages).
- Sort pages according to specific fields.
- Control the number of pages returned or retrieve all available pages.
Practical examples include:
- Generating reports or summaries of pages in a team or project space.
- Synchronizing or backing up pages from a specific space.
- Building integrations that display or manipulate Confluence pages filtered by certain criteria.
Properties
| Name | Meaning |
|---|---|
| Id | The ID of the space for which pages should be returned. This is required to specify the target space. |
| Return All | Boolean flag indicating whether to return all pages in the space or limit the number of results. |
| Limit | Maximum number of pages to return if not returning all. The API limit is 250. |
| Additional Fields | A collection of optional filters and parameters: - Depth: Filter pages at the root level only or all pages in the space. Options: all, root.- Sort: Field name to sort the results by. - Status: Filter pages by status. Options: current, archived, deleted, trashed.- Title: Filter pages by title. - Body Format: Specify the content format type to be returned in the body field of each page. |
Output
The output is a JSON array under the json field containing the list of pages retrieved from the specified space. Each item represents a page object with its properties as returned by the Confluence Cloud REST API v2.
The structure includes typical page metadata such as:
- Page ID
- Title
- Status
- Content body (in the requested format if specified)
- Other page-related metadata depending on the API response
No binary data is output by this operation.
Dependencies
- Requires an authenticated connection to Confluence Cloud via an API key credential.
- The node uses the Confluence Cloud REST API v2 endpoints.
- The user must have 'Can use' global permission and 'View' permission for the specified space to access pages.
Troubleshooting
- Permission errors: If the node returns permission denied errors, ensure the API key has sufficient permissions to view the space and its pages.
- Invalid space ID: Providing an incorrect or non-existent space ID will result in no pages or an error. Verify the space ID before running.
- Limit exceeded: The API limits the maximum number of pages per request to 250. Use the "Return All" option to paginate through all pages.
- Empty results: If no pages are returned, check filters like status, title, or depth that might exclude all pages.
- Malformed additional fields: Ensure that any additional fields like status or depth are set to valid values as per the options.