Skip to main content
POST
Search channels

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
query
string

Structured filter expression. See Query syntax for expression functions. Filterable fields: id, createdAt, updatedAt, name, type, status, vendor, vendorId.

sortBy
string

Sort expression. See Sort By syntax for expression functions. Sortable fields: id, createdAt, updatedAt, name, type, status, vendor, vendorId.

Free-text search by name. See Search.

pagination
object

Page through results. Defaults to page 0 and limit 10 when omitted. See Pagination.

Response

data
object[]
required
pagination
object
required
query
object
required
success
enum<boolean>
required
Available options:
true