Skip to main content
GET
List channels

Authorizations

Authorization
string
header
required

A platform API key, presented as Authorization: Bearer <API_KEY>. Each operation says which permission the key needs.

Path Parameters

space_id
string<uuid>
required

The space to act in.

Query Parameters

page_token
string

An opaque token from a previous response. Omit it to read the first page.

max_results
integer
default:30

The maximum number of items to return.

Required range: 1 <= x <= 100
name
string

Returns only channels whose name contains this value.

status
enum<string>[]

Returns only channels in one of these states.

draft is not fully configured and cannot be activated; inactive is configured but not activated; pending is being provisioned; active can record its source.

Available options:
draft,
inactive,
pending,
active
tag
string[]

Returns only channels carrying all of these tags.

order
enum<string>

Orders the page. Defaults to newest first.

Available options:
creation,
activation,
name_asc,
name_desc

Response

A page of channels.

channels
object[]
required
next_page_token
string | null
required

Pass as page_token to read the next page. Null when no more results remain.