Skip to content

List channel fields​

GET
/channels/{channel_id}/customizations

Retrieves custom field definitions configured for entries within the channel.

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

channel_id*

Channel identifier

Typestring
Required

Responses​

customizations listed

application/json
JSON
[
{
"id": "string",
"name": "string",
"label": "string",
"hint": "string",
"type": "string",
"required": true,
"localized": true,
"encrypted": true,
"auto_expand": true,
"select_options": [
{
"id": "string",
"name": "string",
"label": "string",
"slug": "string",
"position": 0
}
],
"private_storage": true,
"text_formatting": "string"
}
]

Playground​

Authorization
Variables
Key
Value

Samples​