Nimbu Developer Docs
ReferencePages

Fetch a page item subtree

GET
/pages/{page_id}/items/{item_path}

item_path is the part after /items/. Slashes are literal path separators — do not percent-encode them (Blokken/repeatables/<id>, not Blokken%2Frepeatables%2F<id>).

Path grammar

  • <Editable> — a top-level item (Title, Blokken)
  • <Canvas>/repeatables/<24-hex-id> — one repeatable
  • <Canvas>/repeatables/<id>/items/<Editable> — a nested editable

404 when the path cannot be resolved (Item '<Slug>' not found).

Responses

{path, parent_path, position, siblings_count, type, data}:

  • type: item or repeatable
  • data: the PageItem or Repeatable API payload

Query parameters

  • compact=1 — drop created_at/updated_at/type (and slug on items, which path already identifies), the translations entry for the served locale, and file metadata beyond url/filename/width/height
  • content_locale — read translated content in that locale (must be a site locale, else 422)
  • fields is not supported here and is ignored; the subtree is returned whole

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

item_path*string

Path after /items/. Slashes are literal — do not percent-encode (Blokken/repeatables/, not Blokken%2Frepeatables%2F).

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.

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/items/string"

{
  "path": "/items/Blokken",
  "parent_path": "/items",
  "position": 3,
  "siblings_count": 3,
  "type": "item",
  "data": {
    "slug": "Blokken",
    "type": "canvas"
  }
}

{
  "message": "Item 'Missing' not found"
}