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" 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, making it useful for scenarios where you need to gather page data for reporting, content management, or integration with other systems.
Typical use cases include:
- Extracting all pages or a subset based on specific criteria such as space ID, status, or title.
- Automating content audits by retrieving pages with certain statuses (e.g., archived or trashed).
- Integrating Confluence page data into dashboards or external databases.
For example, you could use this operation to get all current pages in a particular space sorted by creation date or to retrieve pages that match a specific title pattern.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all matching pages or limit the number of results. If false, the number of results is limited by the "Limit" property. |
| Limit | Maximum number of pages to return when "Return All" is false. The API limit is 250. |
| Additional Fields | A collection of optional filters and parameters: - Id: Filter pages by one or more page IDs (comma-separated). - Space Id: Filter pages by one or more space IDs (comma-separated). - Sort: Field to sort the results by. - Status: Filter pages by their status; options include Current, Archived, Deleted, Trashed. By default, Current and Archived are used. - 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. |
Output
The output is a JSON array under the json field containing the retrieved pages. Each item represents a page object with its properties as returned by the Confluence Cloud REST API v2. The exact structure depends on the API response but typically includes fields like page ID, title, status, space information, and optionally the page body in the requested format.
If the "Return All" option is enabled, the node will paginate through all available results up to the API's maximum limits.
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 base URL for requests is configured from the user's credentials (the Confluence domain).
Troubleshooting
- Permission Errors: If the user lacks the necessary permissions ("Can use" global permission and view permissions for spaces/pages), the API will deny access. Ensure the API key has appropriate rights.
- Limit Exceeded: The API enforces a maximum limit of 250 results per request. Use the "Return All" option to paginate automatically.
- Invalid Filters: Providing invalid IDs or unsupported filter values may result in empty responses or errors. Double-check filter values.
- Network Issues: Connectivity problems or incorrect domain configuration in credentials can cause request failures.