Skip to main content
GET
/
notifications
/
api
/
v1
/
notifications
/
channels
List notification channels
curl --request GET \
  --url https://www.closient.com/notifications/api/v1/notifications/channels \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "label": "<string>",
      "verified": true,
      "enabled": true
    }
  ],
  "pagination": {
    "page": 2,
    "page_size": 2,
    "total_count": 1,
    "total_pages": 2,
    "has_next": true,
    "has_previous": true
  }
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
channel_type
enum<string> | null

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

Available options:
email,
sms,
in_app
​
enabled
boolean | null

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

​
ordering
string | null

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

200 - application/json

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:
{
  "has_next": true,
  "has_previous": false,
  "page": 1,
  "page_size": 25,
  "total_count": 342,
  "total_pages": 14
}