Skip to main content
GET
List connected messaging channels.

Authorizations

x-api-key
string
header
required

Your workspace API key. It both authenticates the caller and selects the workspace.

Query Parameters

q
string

Keyword filter matched against the channel name and handle.

platform
string

Filter by platform. One of: whatsapp, facebook, instagram, sms, tiktok, telegram, livechat, gbp.

status
string

Filter by connection status (e.g. connected, disconnected).

per_page
integer

Number of results per page (alias: limit). Default 25, maximum 100.

Response

A paginated list.

A paginated collection. per_page defaults to 25 and is capped at 100.

data
object[]
meta
object