Pular para o conteúdo principal
GET
Get accounts for a channel

Supported products

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

channelId
integer<int32>
obrigatório

Parâmetros de consulta

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>
deliveryIdentifierType
enum<string>[]
Opções disponíveis:
HS_EMAIL_ADDRESS,
HS_PHONE_NUMBER,
HS_SHORT_CODE,
CHANNEL_SPECIFIC_OPAQUE_ID
deliveryIdentifierValue
string[]
limit
integer<int32>

The maximum number of results to display per page.

sort
string[]

Resposta

successful operation

results
object[]
obrigatório
total
integer<int32>
obrigatório
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.

Última modificação em 13 de abril de 2026