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 Pages In Space" operation of the Confluence Cloud node retrieves all pages within a specified Confluence space. This operation is useful when you want to list or process all pages that belong to a particular space in your Confluence instance. It supports filtering, sorting, and pagination to tailor the results according to your needs.
Common scenarios:
- Exporting or backing up all pages from a specific space.
- Analyzing or reporting on content structure within a space.
- Automating workflows that involve batch processing of pages in a space.
Example:
You want to get all root-level pages in the "Marketing" space, sorted by title, and only those pages that are currently published (status "current"). You can specify the space ID, set depth to "root", sort by title, and filter status accordingly.
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 or limit the number of results. If true, all pages will be fetched; if false, results are limited by the "Limit" property. |
| Limit | Maximum number of pages to return in one request (minimum 1, maximum 250). Ignored if "Return All" is true. |
| Additional Fields | A collection of optional filters and parameters to refine the query: |
| - Depth | Filter pages by their level in the space hierarchy: "all" for all pages, or "root" for only root-level pages. |
| - Sort | String to specify sorting criteria for the results (e.g., by title, creation date). |
| - Status | Multi-select option to filter pages by their status. Possible values: "current", "archived", "deleted", "trashed". By default, "current" and "archived" are used. |
| - Title | Filter pages based on their title (partial match). |
| - Body Format | Specify the content format types to be returned in the body field of each page's response. If provided, the response will include the body representation under the corresponding format name inside the body field. |
Output
The output JSON contains a list of pages in the results property. Each item represents a page object with its metadata and content details as returned by the Confluence API. The exact structure depends on the API response but typically includes fields like page ID, title, status, version, body content (in requested formats), and other metadata.
If the number of pages exceeds the limit and pagination is enabled, the response may include links to fetch additional pages.
This operation does not output binary data.
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 on the Confluence site and "View" permission for the specified space to retrieve pages.
Troubleshooting
- Permission errors: If the node returns authorization errors, verify that the API key has sufficient permissions both globally and for the target space.
- Invalid space ID: Ensure the space ID provided exists and is accessible.
- Limit exceeded: The Confluence API limits the maximum number of results per request to 250. Use "Return All" to paginate through all results.
- Empty results: If no pages are returned, check filters such as status, title, or depth to ensure they match existing pages.
- Malformed queries: Incorrect values in additional fields like "status" or "depth" may cause API errors. Use valid options as documented.