v1

latestOpenAPI 3.0.32026-07-13218142597.2 KB

Page

Get page by id

Returns a specific page.

Permissions required: Permission to view the page and its corresponding space.

get/pages/{id}

Path parameters

idinteger required

The ID of the page to be returned. If you don't know the page ID, use Get pages and filter the results.

Query parameters

The primary formats a body can be represented as. A subset of BodyRepresentation. These formats are the only allowed formats in certain use cases.

The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.

get-draftboolean

Retrieve the draft version of this page.

statusstring[]

Filter the page being retrieved by its status.

versioninteger

Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details.

include-labelsboolean

Includes labels associated with this page in the response. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results.

include-propertiesboolean

Includes content properties associated with this page in the response. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results.

include-operationsboolean

Includes operations associated with this page in the response, as defined in the Operation object. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results.

include-likesboolean

Includes likes associated with this page in the response. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results.

include-versionsboolean

Includes versions associated with this page in the response. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results.

include-versionboolean

Includes the current version associated with this page in the response. By default this is included and can be omitted by setting the value to false.

include-favorited-by-current-user-statusboolean

Includes whether this page has been favorited by the current user.

include-webresourcesboolean

Includes web resources that can be used to render page content on a client.

include-collaboratorsboolean

Includes collaborators on the page.

include-direct-childrenboolean

Includes direct children of the page, as defined in the ChildrenResponse object.

Response

Returned if the requested page is returned.

idstring

ID of the page.

The status of the content.

titlestring

Title of the page.

spaceIdstring

ID of the space the page is in.

parentIdstring

ID of the parent page, or null if there is no parent page.

parentType'page' | 'whiteboard' | 'database' | 'embed' | 'folder'

Content type of the parent, or null if there is no parent.

positioninteger nullable

Position of child page within the given parent page tree.

authorIdstring

The account ID of the user who created this page originally.

ownerIdstring nullable

The account ID of the user who owns this page.

lastOwnerIdstring nullable

The account ID of the user who owned this page previously, or null if there is no previous owner.

createdAtstring date-time

Date and time when the page was created. In format "YYYY-MM-DDTHH:mm:ss.sssZ".

isFavoritedByCurrentUserboolean

Whether the page has been favorited by the current user.