Skip to main content
GET
List notification channels

Authorizations

X-API-Key
string
header
required

Query Parameters

channel_type
enum<string>

Restrict to channels of a single type (email, sms, in_app).

Available options:
email,
sms,
in_app
enabled
boolean

If set, restrict to enabled (true) or paused (false) channels.

ordering
string

Sort order. One of label, created, -label, -created.

page
integer
default:1

Page number (1-indexed).

Required range: x >= 1
page_size
integer
default:25

Number of items per page (max 100).

Required range: 1 <= x <= 100

Response

OK

data
ChannelSchema · object[]
required

Items on the current page, each conforming to the endpoint's item schema. Empty when the result set is empty or page is past the end.

pagination
PaginationMeta · object
required

Pagination envelope describing position within the full result set.

Example: