Pages

Docs are rich-text pages in a two-level hierarchy: a doc (root page) owns sharing settings, memberships and the project link; subpages nest under it. Page bodies are ProseMirror JSON — write them through the markdown/HTML endpoints; raw body writes are not part of the public API.

Edit history lives in page_versionsGROUP ; root pages on a project also carry custom fields.

Attributes

attachment_ids object
Request

IDs of attachments associated with this page.
attachments array of attachment
Response

Attachments linked to this page.
body object
Response Request

Rich text body of the page in ProseMirror JSON format.
cover_image_meta string
Response

Metadata for the cover image, such as dimensions and focal point.
cover_image_url string
Response Request

URL of the cover image displayed at the top of the page.
created_at string
Response Parameter `filter` Parameter `sort`

Timestamp when the page was created.
creator person
Response

The person who created this page.
creator_id integer
Parameter `filter`

ID of the person who created this page.
creator_name object
Parameter `sort`

Display name of the page creator.
custom_fields object
Response Request Parameter `filter`

Custom field values set on this page. Only available on root pages that belong to a project.
edited_at string
Response Parameter `filter` Parameter `sort`

Timestamp when the page content was last edited.
full_query string
Parameter `filter`

Full-text search query matching across all page fields including title and body.
fuzzy_dates string
Parameter `filter`

Fuzzy date values extracted from page content for search matching.
fuzzy_people integer
Parameter `filter`

Person IDs associated with the page for fuzzy search matching.
icon_id string
Response Request

Emoji or icon identifier displayed next to the page title.
id integer
Parameter `filter` Parameter `sort`

Unique identifier of the page.
jump_query string
Parameter `filter`

Short query used for jump-to search navigation across pages.
last_activity_at string
Response Parameter `filter` Parameter `sort`

Timestamp of the most recent activity on this page.
organization organization
Response

The organization this page belongs to.
parent_page page
Response

The parent page of this page in the hierarchy, if any.
parent_page_id integer
Response Request Parameter `filter`

ID of the parent page in the hierarchy, or null if this is a root page.
person_type integer
Parameter `filter`

Indicates the membership context of the current user (e.g. member or guest).
position integer
Response Request

The display order position of this page among its siblings.
preferences object
Response Request

Page-level display preferences such as layout width, font size and default edit access.
project project
Response Parameter `sort`

The project this page is associated with, if any.
project_id integer
Request Parameter `filter`

ID of the project this page belongs to.
project_name object
Parameter `sort`

Name of the project this page belongs to.
project_status integer
Parameter `filter` Enum

Status of the project this page belongs to (active or archived).

Enum Values (2 values)

  • 1
    Active
  • 2
    Archived
public object
Response

Whether this page is publicly accessible via a shared link.
public_access boolean
Response

Controls whether the page can be viewed publicly without authentication.
public_uuid string
Response

UUID used in the public sharing URL for this page.
query string
Parameter `filter`

Search query matched against page title only.
root_page page
Response

The root Doc page of the hierarchy this page belongs to. Null for root pages themselves.
root_page_id integer
Response Request Parameter `filter`

ID of the root Doc page. Null if this page is itself a root Doc.
status integer
Parameter `filter`

The status filter value used when querying pages (active or archived).
steps array of object
Request

The ProseMirror steps applied to this page's content during collaborative editing.
subscriber_id integer
Parameter `filter`

ID of the subscriber (person) watching this page for updates.
target_doc_id integer
Request

ID of the destination page for PATCH /pages/{id}/move; the moved page becomes its last child.
template string
Parameter `filter`

Filter only — pass filter[template] to return only template docs, i.e. docs on template projects.
template_id integer
Request

ID of the source page: the page being copied on POST /pages/copy, or the template doc on the apply_template_* actions.
template_object template
Response

The template this page was created from, if any.
title string
Response Request Parameter `sort`

Title of the page.
updated_at string
Response Parameter `sort`

Timestamp when the page record was last updated.
updater person
Response

The person who last edited this page.
version_number integer
Response Request

Incremental version counter for the page body, used to detect and prevent conflicting edits.

Examples

Loading example

Operations

GET /api/v2/pages
Get pages
POST /api/v2/pages/create_with_markdown
Create a page with markdown body
GET /api/v2/pages/{id}
Gets a page
DELETE /api/v2/pages/{id}
Deletes a page
PATCH /api/v2/pages/{id}/replace_body_with_markdown
Replace a page body with markdown
PATCH /api/v2/pages/{id}/replace_body_with_html
Replace a page body with HTML
PATCH /api/v2/pages/{id}/append_markdown
Append markdown to a page body
PATCH /api/v2/pages/{id}/append_html
Append HTML to a page body
POST /api/v2/pages/copy
Copies a page
PATCH /api/v2/pages/{id}/move
Moves a page
PATCH /api/v2/pages/{id}/convert_to_doc
Converts a subpage into a doc
POST /api/v2/pages/apply_template_as_doc
Creates a doc from a template
PATCH /api/v2/pages/{id}/apply_template_as_target
Applies a template onto a page
PATCH /api/v2/pages/{id}/apply_template_on_parent
Creates a subpage from a template
PATCH /api/v2/pages/{id}/publish
Publishes a page
PATCH /api/v2/pages/{id}/unpublish
Unpublishes a page
GET /api/v2/public/pages/{uuid}
Gets a public doc