Nimbu Developer Docs
ReferencePages

Fetch a page

GET
/pages/{page_id}

Fetch a page by id or fullpath.

ETag flow

Success includes header ETag: "<md5>" — a quoted strong ETag from page id + updated_at. Send that exact header value as If-Match on POST /pages/{page_id}/batch (required there), or on PUT/PATCH/POST /pages/{page_id} and DELETE /pages/{page_id} (optional; checked when sent). X-Nimbu-Content-ETag carries the same value. Only single strong ETags are supported; W/"..." and multi-value If-Match are rejected as stale (412).

Query parameters

  • compact=1 — strips redundant editable metadata: per-editable created_at/updated_at, the slug that is already the items key, type, the translations entry for the served locale, and file metadata beyond url/filename/width/height. Ids, positions and page-level fields stay.
  • fields — comma-separated top-level keys (items selects the whole items tree); id and url are always returned
  • content_locale — read translated content in that locale (must be a site locale, else 422). Other locales stay under translations unless compact=1.

Authorization

AuthorizationBearer <token>

Personal access token tied to a user account. Requires the X-Nimbu-Site header to scope requests.

In: header

X-Nimbu-Site<token>

Identifier of the site context when authenticating with a personal access token.

In: header

Path Parameters

page_id*string

Page identifier or fullpath

Query Parameters

compact?boolean

When true, drop redundant metadata: per-editable created_at/updated_at, the slug that is already the items key, type, the translations entry for the served locale, and file metadata beyond url/filename/width/height. Ids and positions stay.

fields?string

Comma-separated top-level keys to return (items selects the whole items tree). id and url are always included.

content_locale?string

Locale to read translated content in. Must be one of the site locales (default = site default).

Response Body

application/json

application/json

curl -X GET "https://example.com/pages/string"
{
  "id": "66f1a2b3c4d5e6f7a8b9c0d0",
  "slug": "home",
  "title": "Home",
  "published": true
}
{
  "message": "string",
  "errors": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  }
}