Pages
Contains structured data about all Confluence pages, including titles, content IDs, authors, and associated spaces.
Table Specific Information
Select
The server will use the Confluence API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the server. You can also search for Attachments using CQL (Confluence Query Language).
- Id supports the '=,!=,IN,NOT IN' comparisons.
- Type supports the '=,!=,IN,NOT IN' comparisons.
- Title supports the '=,!=,LIKE,NOT LIKE,IN,NOT IN' comparisons.
- SpaceKey supports the '=,!=,IN,NOT IN' comparisons.
- SpaceType supports the '=,!=,IN,NOT IN' comparisons.
- CreatedByUserName supports the '=,!=,IN,NOT IN' comparisons.
- CreatedDate supports the '=,!=,>,>=,<,<=' comparisons.
- LastUpdatedDatetime supports the '=,!=,>,>=,<,<=' comparisons.
For example, the following queries are processed server side:
SQL
SELECT * FROM Pages WHERE Id = '1234'
SELECT * FROM Pages WHERE Id IN ('1234', '2345')
SELECT * FROM Pages WHERE Id = '294922' OR Type = 'page'
SELECT * FROM Pages WHERE CreatedDate <= '2019/03/29 15:00' AND Id IN ('1234', '2345')
Additionally Id, Type, Title, CreatedDate, CreatedByUserName, AND LastUpdatedDatetime columns can be used in the ORDER BY clause, as following:
SELECT * FROM Pages ORDER BY Id DESC SELECT * FROM Pages ORDER BY CreatedByUserName ASC
CQL
Note: Filtering with CQL has the highest priority and all the other filters except "Excerpt" will be ignored when CQL filter is present in the query.
SELECT * FROM Pages WHERE CQL = 'creator = currentUser() AND content = "1234" OR space.type = "global"'
Columns
| Name | Type | ReadOnly | References | SupportedOperators | Description |
| Id [KEY] | String | False | =,!=,IN,NOT_IN |
The unique identifier of the page within Confluence. Used to reference the page in related operations and tables. | |
| Type | String | True | =,!=,IN,NOT_IN |
Specifies the content type, indicating that this record represents a page. | |
| Title | String | False | =,!=,IN,NOT_IN,LIKE |
The title of the page as displayed in Confluence. | |
| Status | String | False | =,IN |
Indicates the current state of the page, such as current, draft, or archived. | |
| Storage | String | False |
Contains the body content of the page in Confluence Storage Format, including text, macros, and formatting elements. | ||
| AtlasDocFormat | String | False |
Stores the page body content in Atlas Document Format (ADF), the structured format used by modern Confluence editors. | ||
| Position | Integer | True |
Indicates the position of the page within its parent hierarchy, defining its order among sibling pages. | ||
| OwnerId | String | False |
The unique identifier of the user who owns or created the page. | ||
| ParentId | Long | False |
The identifier of the parent page under which this page is nested. | ||
| SpaceId | String | False |
The unique identifier of the space in which the page resides. | ||
| SpaceKey | String | True |
Spaces.Key | =,!=,IN,NOT_IN |
The key of the space to which the page belongs. |
| SpaceType | String | True |
Spaces.Type | =,!=,IN,NOT_IN |
Specifies the type of space containing the page, such as global, personal, or team space. |
| URL | String | True |
The full URL of the page, providing direct access through the Confluence interface or API. | ||
| Excerpt | String | True |
A short summary or snippet of the page content, typically used in listings or search results. | ||
| IsLatest | Boolean | True |
If the value is 'true', this record represents the most recent version of the page. If the value is 'false', it refers to an earlier revision. | ||
| CreatedByUserName | String | True | =,!=,IN,NOT_IN |
The username of the user who originally created the page. | |
| CreatedByUserType | String | True |
Specifies the type of user who created the page, such as internal user, external collaborator, or system account. | ||
| CreatedDate | Datetime | True | =,>,>=,<,<= |
The date and time when the page was first created. | |
| LastUpdatedDatetime | Datetime | True | =,>,>=,<,<= |
The date and time when the page was most recently updated. | |
| LastUpdatedMessage | String | True |
The revision message or comment provided when saving the latest version of the page. | ||
| LastUpdatedNumber | Integer | True |
The version number corresponding to the latest update of the page. | ||
| LastUpdatedUserName | String | True |
The username of the user who performed the most recent update to the page. | ||
| LastUpdatedUserType | String | True |
Specifies the type of user who made the most recent update, such as internal or automated. | ||
| LastUpdatedIsMinorEdit | Boolean | True |
If the value is 'true', the last update was a minor edit that did not significantly alter the content. If the value is 'false', it was a major revision. | ||
| LastUpdatedIsHidden | Boolean | True |
If the value is 'true', the latest version of the page is hidden from general visibility. If the value is 'false', it is visible to users. | ||
| PreviousVersionUserName | String | True |
The username of the user who created or edited the previous version of the page. | ||
| PreviousVersionUserType | String | True |
Specifies the type of user who modified the previous version, such as internal user or automated process. | ||
| PreviousVersionDatetime | Datetime | True |
The date and time when the previous version of the page was edited. | ||
| PreviousVersionMessage | String | True |
The revision message or note entered for the previous version. | ||
| PreviousVersionNumber | String | True |
The version number assigned to the previous revision of the page. | ||
| PreviousVersionIsMinorEdit | Boolean | True |
If the value is 'true', the previous version was a minor edit. If the value is 'false', it represented a major revision. | ||
| PreviousVersionIsHidden | Boolean | True |
If the value is 'true', the previous version of the page is hidden from visibility. If the value is 'false', it is accessible to users. | ||
| VersionUserName | String | True |
The username of the user who created or edited this version of the page. | ||
| VersionUserType | String | True |
Specifies the type of user who modified this version, such as internal or system account. | ||
| VersionDatetime | Datetime | True |
The date and time when this version of the page was last modified. | ||
| VersionMessage | String | False |
The message or note provided when this version was saved. | ||
| VersionNumber | Integer | False |
The version number identifying this specific revision of the page. | ||
| VersionIsMinorEdit | Boolean | True |
If the value is 'true', this version was marked as a minor edit. If the value is 'false', it represents a major change. | ||
| VersionIsHidden | Boolean | True |
If the value is 'true', this version is hidden from general view. If the value is 'false', it is visible to users. | ||
| LinksEditui | String | True |
The URL of the edit interface (EditUI) for the page, allowing direct modification in the Confluence editor. | ||
| LinksSelf | String | True |
The self-referential API endpoint (Self link) for the page, used to retrieve its data programmatically. | ||
| LinksTinyui | String | True |
The short link (TinyUI) version of the page's URL, providing a concise format for sharing. | ||
| LinksWebui | String | True |
The standard web interface URL (WebUI) for viewing the page in Confluence. | ||
| ItemURL | String | True |
The full URL reference to the page as displayed in the Confluence user interface. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| CQL | String |
Represents a Confluence Query Language (CQL) expression used to construct structured queries for retrieving or filtering pages. |