Skip to content

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.

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

Response200
json
{
  "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"
}