Channel accounts

Retrieve Channel Account

Changed on

Retrieve details of a specific channel account in your HubSpot account using the unique channelAccountId. This endpoint is useful for accessing information about a particular channel account, including its archived status.

get/conversations/conversations/2026-09/channel-accounts/{channelAccountId}

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/conversations/conversations/2026-09/channel-accounts/{channelAccountId}
  • Auth
    OAuth 2
    Authorization code: https://app.hubspot.com/oauth/authorize
    Token URL: https://api.hubapi.com/oauth/v1/token scopes: conversations.read

Path parameters

channelAccountIdinteger required

The unique identifier of the channel account to retrieve.

Query parameters

archivedboolean

Whether to return only results that have been archived. Defaults to false.

Response

successful operation

activeboolean required

A boolean indicating whether the channel account is currently active.

archivedboolean required

A boolean indicating whether the channel account is archived.

archivedAtstring date-time

The date and time when the channel account was archived, in ISO 8601 format.

authorizedboolean required

A boolean indicating whether the channel account is authorized.

channelIdstring required

The unique identifier for the channel associated with this account, represented as a string.

createdAtstring date-time required

The date and time when the channel account was created, in ISO 8601 format.

idstring required

The unique identifier for the channel account, represented as a string.

inboxIdstring required

The unique identifier for the inbox associated with this channel account, represented as a string.

namestring required

The name of the channel account, represented as a string.

Changes