Sign in

v1

latestOpenAPI 3.1.02026-08-0612447737.4 KB
Channel

List Channels

Retrieve a list of channels

get/channel

Query parameters

idstring

Channel ID

created_atstring

Channel creation date

updated_atstring

Latest update

organisation_idstring

Organisation ID

typestring

Channel type

namestring

Name of channel

handlestring

Channel handle

statusstring

Status of channel

activestring

Is channel active?

selectstring

Filtering Columns

orderstring

Ordering. Allowed Fields: name

offsetstring

Limiting and Pagination

limitstring

Limiting and Pagination

Headers

Rangestring

Limiting and Pagination

Range-Unitstring

Limiting and Pagination

Response

OK

idstring uuid

Channel ID

created_atstring timestamp with time zone

Channel creation date

updated_atstring timestamp with time zone

Latest update

organisation_idstring uuid

Organisation ID

type'email' | 'sms' | 'whatsapp' | 'instagram' | 'facebook' | 'google_business_messaging' | 'postal' public.channel_type

Channel type

namestring text nullable

Name of channel

handlestring text nullable

Channel handle

status'draft' | 'in-review' | 'rejected' | 'active' | 'inactive' public.channel_status

Status of channel

activeboolean nullable

Is channel active?