Docs API

Use the Docs API for workspace pages and version history. Content writes can return 409 when a live collaborative edit session is active; fetch the page and retry after the editor settles.

Endpoints

List docs pages

Scope

docs:read

Parameters

spaceIdstringFilter by docs space

statestringactive or archived (default active)

limitnumberNumber of pages (max 100, default 50)

cursorstringComposite pagination cursor from the previous page

Response

{
  "items": [
    {
      "id": "doc_abc123",
      "spaceId": "spc_xyz789",
      "title": "Launch runbook",
      "visibility": "shared",
      "state": "active",
      "version": 4,
      "updatedAt": 1779680000000
    }
  ],
  "nextCursor": null
}

Create a docs page

Scope

docs:write

Parameters

spaceIdstringrequiredSpace that owns the page

titlestringPage title

iconstringOptional page icon

visibilitystringpublic, private, or shared

contentobjectInitial Plate-compatible document content

Get one docs page

Scope

docs:read

Parameters

idstringrequiredDocs page ID (URL path)

Update page metadata

Scope

docs:write

Parameters

idstringrequiredDocs page ID (URL path)

titlestringNew title

iconstringNew icon

fullWidthbooleanRender page content at full width

visibilitystringpublic, private, or shared

Replace page content

Scope

docs:write

Parameters

idstringrequiredDocs page ID (URL path)

contentobjectrequiredPlate-compatible document content

changeNotestringVersion history note

List saved versions for a page

Scope

docs:read

Parameters

idstringrequiredDocs page ID (URL path)

limitnumberNumber of versions (max 200, default 50)

Restore a page to a previous version

Scope

docs:write

Parameters

idstringrequiredDocs page ID (URL path)

versionnumberrequiredPositive version number

Archive a docs page

Scope

docs:write

Parameters

idstringrequiredDocs page ID (URL path)

Restore an archived docs page

Scope

docs:write

Parameters

idstringrequiredDocs page ID (URL path)

Delete a docs page

Scope

docs:write

Parameters

idstringrequiredDocs page ID (URL path)