Skip to content

List channels

GET
/channels

Lists all channels available on the site, including slugs and statuses.

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)

Responses

channels listed

application/json
JSON
[
{
"id": "string",
"url": "string",
"entries_url": "string",
"slug": "string",
"name": "string",
"description": "string",
"created_at": "string",
"updated_at": "string",
"sensitive": true,
"customizations": [
{
}
],
"acl": {
"create": "string",
"read": "string",
"update": "string",
"delete": "string"
},
"submittable": true,
"rss_enabled": true,
"label_field": "string",
"title_field": "string",
"order_by": "string",
"order_direction": "string",
"search_enabled": true,
"search_excluded_field_ids": [
"string"
],
"submittable_fields": [
"string"
],
"submittable_html_fields": [
"string"
],
"submittable_notifications": true,
"submittable_receivers": "string",
"submittable_notification_template": "string",
"submittable_confirmations": true,
"submittable_confirmation_receivers": "string",
"submittable_confirmation_template": "string",
"spam_detection": true,
"rss_title": "string",
"rss_description": "string",
"rss_title_field": "string",
"rss_description_field": "string"
}
]

Playground

Authorization

Samples

Part of Nimbu, built by Zenjoy.