Skip to main content
GET
Get accounts for a channel

Supported products

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

conversations.custom_channels.read
conversations.custom_channels.write

Path Parameters

channelId
integer<int32>
required

The unique identifier of the channel for which to list the accounts.

Query Parameters

after
string

The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results.

archived
boolean

Whether to return only results that have been archived.

defaultPageLength
integer<int32>

The default number of results to display per page.

deliveryIdentifierType
enum<string>[]

An array of delivery identifier types to filter the results. Valid values include HS_EMAIL_ADDRESS, HS_PHONE_NUMBER, HS_SHORT_CODE, and CHANNEL_SPECIFIC_OPAQUE_ID.

Available options:
HS_EMAIL_ADDRESS,
HS_PHONE_NUMBER,
HS_SHORT_CODE,
CHANNEL_SPECIFIC_OPAQUE_ID
deliveryIdentifierValue
string[]

An array of delivery identifier values to filter the results.

limit
integer<int32>

The maximum number of results to display per page.

sort
string[]

An array specifying the sort order of the results.

Response

successful operation

results
object[]
required

An array of PublicChannelAccount objects, each representing a public channel account with its details.

total
integer<int32>
required

An integer representing the total number of public channel accounts available.

paging
object

Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results.

Last modified on September 9, 2026