HubSpot: Get accounts for a channel

← Custom channels operations · Get started

Operation hubspot.custom_channels_get_channel_accounts

Provider route: GET /conversations/custom-channels/2026-09/{channelId}/channel-accounts. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/hubspot with npm, or alter-sdk-hubspot with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HubSpotIntegration } from "@alter-ai/hubspot";

async function execute(input: Parameters<HubSpotIntegration["customChannels"]["getChannelAccounts"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HubSpotIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.customChannels.getChannelAccounts(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_hubspot import HubSpotIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HubSpotIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.custom_channels.get_channel_accounts(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.channelId	integer	Required within parent	Format: int32
query	object	Optional	Additional keys: not allowed
query.after	string	Optional
query.archived	boolean	Optional
query.defaultPageLength	integer	Optional	Format: int32
query.deliveryIdentifierType	array	Optional
query.deliveryIdentifierType[]	string	Each item	One of: HS_EMAIL_ADDRESS, HS_PHONE_NUMBER, HS_SHORT_CODE, CHANNEL_SPECIFIC_OPAQUE_ID
query.deliveryIdentifierValue	array	Optional
query.deliveryIdentifierValue[]	string	Each item
query.limit	integer	Optional	Format: int32
query.sort	array	Optional
query.sort[]	string	Each item

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Get accounts for a channel — response body

Referenced models: Get accounts for a channel — response body

Schemas

Get accounts for a channel — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand Get accounts for a channel — response body — paging
results	array	Required within parent	An array of PublicChannelAccount objects, each representing a public channel account with its details.
results[]	Model	Each item	Expand Create a channel account — response body
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	An integer representing the total number of public channel accounts available. Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get accounts for a channel — response body — paging, Create a channel account — response body

Get accounts for a channel — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	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.
next	Model	Optional	Expand Get all tax rates — response body — paging next
prev	Model	Optional	Expand Get accounts for a channel — response body — paging prev

Referenced models: Get all tax rates — response body — paging next, Get accounts for a channel — response body — paging prev

Create a channel account — response body

Field	Type	Presence	Description and constraints
$	object	Root
active	boolean	Required within parent	A boolean indicating whether the channel account is currently active.
archived	boolean	Required within parent	A boolean indicating whether the channel account is archived.
archivedAt	string	Optional	The date and time when the channel account was archived, in ISO 8601 format. Format: date-time
authorized	boolean	Required within parent	A boolean indicating whether the channel account is authorized.
channelId	string	Required within parent	The unique identifier for the channel to which this account belongs, represented as a string.
createdAt	string	Required within parent	The date and time when the channel account was created, in ISO 8601 format. Format: date-time
deliveryIdentifier	Model	Optional	Expand Create a channel account — response body — delivery Identifier
id	string	Required within parent	The unique identifier for this channel account, represented as a string.
inboxId	string	Required within parent	The unique identifier for the inbox associated with this channel account, represented as a string.
name	string	Required within parent	The name of the channel account, represented as a string.

Referenced models: Create a channel account — response body — delivery Identifier

Get all tax rates — response body — paging next

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the paging information needed to retrieve the next set of results in a paginated API response
after	string	Required within parent	A paging cursor token for retrieving subsequent pages.
link	string	Optional	A URL that can be used to retrieve the next page results.

Get accounts for a channel — response body — paging prev

Field	Type	Presence	Description and constraints
$	object	Root	specifies the paging information needed to retrieve the previous set of results in a paginated API response
before	string	Required within parent	A string token indicating the position before the current page in the pagination sequence.
link	string	Optional	A URL string that can be used to access the previous page of results.

Create a channel account — response body — delivery Identifier

Field	Type	Presence	Description and constraints
$	object	Root
type	string	Required within parent	A string representing the type of delivery identifier. Valid values include 'HS_EMAIL_ADDRESS', 'HS_PHONE_NUMBER', 'HS_SHORT_CODE', and 'CHANNEL_SPECIFIC_OPAQUE_ID'. Known values: CHANNEL_SPECIFIC_OPAQUE_ID, HS_EMAIL_ADDRESS, HS_PHONE_NUMBER, HS_SHORT_CODE
value	string	Required within parent	A string representing the value associated with the delivery identifier type.

Policy, approvals and errors

SDK function policy ID: hubspot.custom_channels_get_channel_accounts. Catalog operation: custom_channels_get_channel_accounts. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["conversations.custom_channels.read", "conversations.custom_channels.write"]

Official provider source