Skip to main content
GET
List channel accounts
A channel account is the provider connection a channel actually sends through — the WhatsApp number, the SMS route, the email sender. Templates reference them by channelAccountId, so this endpoint is how you resolve that id into something readable, and how you check whether a channel is live before you try to send on it.
A disabled channel account fails the send at dispatch time with channel_account_disabled (409), even though the template still lists the channel. If a channel starts failing for every destination, check status here before looking anywhere else.

Credentials

credentialFields[] describes the provider credentials the account is configured with. Fields marked secret: true always come back with an empty value — the API never returns a credential, and there is no parameter that makes it. Use the key and label to render a settings view; change the values in the OneXtel portal.

Paging

Page-numbered, the same as List templates: pass page and pageSize, read total and totalPages, and trust the echoed values, which are post-clamp.

Authorizations

Authorization
string
header
required

An API key from the OneXtel portal, Developers → API Keys, sent as Authorization: Bearer <key>.

Query Parameters

channelType
enum<string>
Available options:
sms,
whatsapp,
email
status
enum<string>
Available options:
enabled,
disabled
archived
boolean
page
integer
default:1

1-based page number. Out-of-range or unparseable values read as page 1.

pageSize
integer
default:25

Rows per page. Defaults to 25; larger values clamp to 100.

Required range: x <= 100
sortBy
string
default:createdAt

Column to sort by. Defaults to createdAt. Enum-typed columns sort by declaration order, not alphabetically.

sortOrder
enum<string>
default:desc

Sort direction. Defaults to desc.

Available options:
asc,
desc

Response

OK

page
integer
Example:

1

pageSize
integer
Example:

25

total
integer
Example:

137

totalPages
integer
Example:

6

data
object[]