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" operation of the Confluence Cloud node retrieves a list of pages from a Confluence site. It allows users to fetch multiple pages with various filtering and sorting options, such as filtering by page IDs, space IDs, status, title, subtype, and specifying the format of the page body content returned.
This operation is useful for scenarios where you want to:
- List all or a subset of pages in your Confluence instance.
- Filter pages based on specific criteria like their status (current, archived, deleted, trashed).
- Retrieve pages belonging to certain spaces or with particular titles.
- Control the amount of data returned by limiting the number of results or returning all available pages.
- Customize the content format of the page bodies for further processing or display.
Practical examples include:
- Generating reports or dashboards that summarize pages in certain spaces.
- Syncing or backing up page metadata and content.
- Automating workflows that depend on page statuses or titles.
- Integrating Confluence page data into other tools or systems.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all matching pages or only up to a specified limit. |
| Limit | Maximum number of pages to return when not returning all. The API limit is 250. |
| Additional Fields | A collection of optional filters and parameters: - Id: Filter by one or more page IDs (comma-separated). - Space Id: Filter by one or more space IDs (comma-separated). - Sort: Field to sort results by. - Status: Filter pages by status; options are Current, Archived, Deleted, Trashed. Defaults to current and archived if not specified. - Title: Filter pages by title. - Body Format: Specify the content format type to be returned in the body field of each page. - Subtype: Filter pages by subtype; options are Live or Page. Default is Live. |
Output
The output JSON contains a property named results, which is an array of page objects matching the query. Each page object includes metadata about the page such as its ID, title, status, space information, and optionally the page body content in the requested format.
If the user chooses to return all results, the node will paginate through the API responses internally to collect all pages up to the API's maximum limits.
No binary data is output by this operation.
Dependencies
- Requires an API key credential for authenticating with the Confluence Cloud REST API.
- The node expects the base URL of the Confluence instance to be configured in the credentials.
- Permissions required: The authenticated user must have permission to access the Confluence site ("Can use" global permission) and view the pages being requested.
Troubleshooting
- Permission errors: If the node returns authorization errors, verify that the API key has sufficient permissions to access the Confluence site and view pages.
- Limit exceeded: The API enforces a maximum limit of 250 pages per request. Use the "Return All" option to retrieve more than 250 pages via pagination.
- Invalid filter values: Ensure that IDs, space IDs, status values, and other filters are correctly formatted and valid within your Confluence instance.
- Empty results: If no pages are returned, check the filter criteria and confirm that pages matching those criteria exist and are accessible.
- API endpoint changes: Since the node uses the Confluence Cloud REST API, any breaking changes in the API may affect functionality. Keep the node and credentials updated accordingly.