Get channel

GET

/channels/{channel_id}

Returns the full configuration for a single channel identified by ID or slug.

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 (id or slug)

Typestring

Required

Responses

channel returned

Content-Type

application/json

{

"id": "string",

"url": "string",

"entries_url": "string",

"slug": "string",

"name": "string",

"description": "string",

"created_at": "string",

"updated_at": "string",

"sensitive": true,

"acl": {

},

"submittable": true,

"rss_enabled": true,

"label_field": "string",

"title_field": "string",

"order_by": "string",

"order_direction": "string",

"entries_custom_fields": [

{

}

],

"additionalProperties": "string"

}

GET

/channels/{channel_id}

Playground

Authorization

bearerToken

siteContext

Variables

Key

Value

channel_id*

Samples