Channel accounts

Get accounts for a channel

Changed on

Retrieve a list of accounts for a custom channel.

get/conversations/v3/custom-channels/{channelId}/channel-accounts

Request

  • Base URL
    https://api.hubapi.com
  • Auth
    • OAuth 2
      Authorization codehttps://app.hubspot.com/oauth/authorize
      Token URLhttps://api.hubapi.com/oauth/v1/token
      Scopesconversations.custom_channels.read
    • or OAuth 2
      Authorization codehttps://app.hubspot.com/oauth/authorize
      Token URLhttps://api.hubapi.com/oauth/v1/token
      Scopesconversations.custom_channels.write

Path parameters

channelIdinteger required

Query parameters

afterstring

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.

archivedboolean

Whether to return only results that have been archived.

defaultPageLengthinteger
deliveryIdentifierTypestring[]
deliveryIdentifierValuestring[]
limitinteger

The maximum number of results to display per page.

sortstring[]

Response

successful operation

totalinteger required

Changes

    • info

      the security scope conversations.custom_channels.read was added to the endpoint's security scheme oauth2

    • info

      the security scope conversations.custom_channels.write was removed from the endpoint's security scheme oauth2

    • info

      the security scope conversations.custom_channels.read was added to the endpoint's security scheme oauth2

    • info

      the security scope conversations.custom_channels.write was removed from the endpoint's security scheme oauth2