Skip to main content
GET
List channels

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Query Parameters

page
integer
Required range: x >= 1
limit
integer
default:15
Required range: 1 <= x <= 100
sortField
string
sortDirection
enum<string>
Available options:
asc,
desc
label
string

Substring match on channel label.

tagIds
integer[]

Channels that have at least one of the listed tag IDs.

status
integer
isPosChannel
boolean
isCustomerSpecific
boolean
isPushOrderToOms
boolean

When true, filters to channels that have a push-order integration mapping.

channelTypes
string

Comma-separated list of channel types (e.g. sales_channel,end_to_end_channel).

Response

Successful response

data
object[]
meta
object