Overview

Pages allow you to create and manage documentation at both workspace and project levels. Workspace pages are accessible across all projects, while project pages are specific to individual projects. Page body mutations are applied to Plane's collaborative document so API updates remain consistent with active editor sessions.

Documentation: Wiki, Pages

The Pages Object

Attributes

• id uuid

  Unique identifier for the page

• name string

  Name of the page

• description_html string

  HTML description/content of the page

• created_at timestamp

  The timestamp when the page was created

• updated_at timestamp

  The timestamp when the page was last updated

• created_by uuid

  ID of the user who created the page

• updated_by uuid

  ID of the user who last updated the page

• parent_id uuid or null

  ID of the parent page for a child page

• collection_id uuid or null

  ID of the collection containing a workspace page

• page_collection_id uuid or null

  ID of the page's placement record within its collection

• archived_at timestamp or null

  Time the page was archived

• is_locked boolean

  Whether content mutations are blocked

Response200

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "created_at": "2023-11-19T11:56:55.176802Z",
  "updated_at": "2023-11-19T11:56:55.176809Z",
  "name": "Getting Started",
  "description_html": "<h1>Welcome</h1><p>This is a getting started guide.</p>",
  "created_by": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "updated_by": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "parent_id": null,
  "collection_id": "0a8a3e6a-3c32-49c7-bbb5-b7a8e32c2f10",
  "page_collection_id": "1d9b4f7b-56e8-4c63-9ff4-e24b508c162d",
  "archived_at": null,
  "is_locked": false
}