Skip to content

Get page schema​

GET
/pages/{page_id}/schema

Retrieves the schema for a page including available block types, current structure, and select field options. Use this endpoint to discover what modifications are valid before calling the batch endpoint.

Authorizations​

bearerToken|siteContext
bearerToken

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

TypeHTTP (bearer)
+
siteContext

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

TypeAPI Key (header: X-Nimbu-Site)
or
siteToken

Site-scoped API token that already encodes the site context.

TypeHTTP (bearer)

Parameters​

Path Parameters

page_id*

Page identifier (ObjectId) or fullpath

Typestring
Required

Responses​

page schema returned

application/json
JSON
{
"template": {
"id": "string",
"name": "string"
},
"available_blocks": {
"additionalProperties": [
]
},
"current_structure": {
},
"select_options": {
"additionalProperties": [
]
}
}

Playground​

Authorization
Variables
Key
Value

Samples​