Skip to main content

Pages

List pages

Returns all pages in a project, sorted alphabetically by path.

GET/projects/{id}/pages
List pages
curl --request GET \
  --url 'https://api.nookdocs.com/v1/projects/{id}/pages' \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "path": "<string>",
      "title": "<string>",
      "version": "<string>",
      "source_mdx": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "compiled_html": "<string>"
    }
  ]
}

Authorizations

Authorizationstringheaderrequired

API key issued from your dashboard (Settings → API Keys). Format: nook_... — pass as Authorization: Bearer nook_.... Keys carry scopes (projects:read/write, pages:read, deployments:read/trigger, analytics:read) — calls without the required scope return 403.

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path parameters

idstring (uuid)pathrequired
Project UUID

Query parameters

versionstringquerydefault: latest
Page version to list (defaults to `latest`)

Response

application/json

Array of pages

dataobject[]