> ## Documentation Index > Fetch the complete documentation index at: https://br.developers.hubspot.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get accounts for a channel > Recupere uma lista de contas para um canal personalizado. > [accordion] Supported products > [accordion] Required Scopes ## OpenAPI ````yaml specs/2026-03/conversations-custom-channels-v2026-03.json GET /conversations/custom-channels/2026-03/{channelId}/channel-accounts openapi: 3.0.1 info: title: Conversations Custom Channels description: Basepom for all HubSpot Projects version: 2026-03 x-hubspot-product-tier-requirements: marketing: FREE sales: PROFESSIONAL service: PROFESSIONAL cms: FREE commerce: FREE crmHub: FREE dataHub: FREE x-hubspot-api-use-case: >- Allow admins to install an integration with a third-party messaging channel that your team uses to communicate with customers, to allow users in your account to manage their conversations for that channel directly in HubSpot. x-hubspot-introduction: >- Use the custom channels API to create custom channels to build a bridge between an external message service and HubSpot's inbox or help desk features. servers: - url: https://api.hubapi.com security: [] tags: - name: Basic - name: Channel accounts - name: Channels - name: Messages paths: /conversations/custom-channels/2026-03/{channelId}/channel-accounts: get: tags: - Channel accounts summary: Obter contas para um canal description: Recupere uma lista de contas para um canal personalizado. operationId: get-/conversations/custom-channels/2026-03/{channelId}/channel-accounts parameters: - name: channelId in: path description: O identificador exclusivo do canal para o qual listar as contas. required: true style: simple explode: false schema: type: integer format: int32 - name: after in: query description: >- O token do cursor de paginação do último recurso lido será retornado como a propriedade JSON `paging.next.after` de uma resposta paginada que contém mais resultados. required: false style: form explode: true schema: type: string - name: archived in: query description: Se apenas os resultados que foram arquivados devem ser retornados. required: false style: form explode: true schema: type: boolean - name: defaultPageLength in: query description: O número padrão de resultados a serem exibidos por página. required: false style: form explode: true schema: type: integer format: int32 - name: deliveryIdentifierType in: query description: >- Uma matriz de tipos de identificadores de entrega para filtrar os resultados. Os valores válidos incluem HS_EMAIL_ADDRESS, HS_PHONE_NUMBER, HS_SHORT_CODE e CHANNEL_SPECIFIC_OPAQUE_ID. required: false style: form explode: true schema: type: array items: type: string enum: - HS_EMAIL_ADDRESS - HS_PHONE_NUMBER - HS_SHORT_CODE - CHANNEL_SPECIFIC_OPAQUE_ID - name: deliveryIdentifierValue in: query description: >- Uma matriz de valores de identificador de entrega para filtrar os resultados. required: false style: form explode: true schema: type: array items: type: string - name: limit in: query description: O número máximo de resultados a serem exibidos por página. required: false style: form explode: true schema: type: integer format: int32 - name: sort in: query description: Uma matriz que especifica a ordem de classificação dos resultados. required: false style: form explode: true schema: type: array items: type: string responses: '200': description: successful operation content: application/json: schema: $ref: >- #/components/schemas/CollectionResponseWithTotalPublicChannelAccount default: $ref: '#/components/responses/Error' description: '' security: - oauth2: - conversations.custom_channels.read - oauth2: - conversations.custom_channels.write components: schemas: CollectionResponseWithTotalPublicChannelAccount: required: - results - total type: object properties: paging: $ref: '#/components/schemas/Paging' results: type: array description: >- Uma matriz de objetos PublicChannelAccount, cada um representando uma conta de canal público com seus detalhes. items: $ref: '#/components/schemas/PublicChannelAccount' total: type: integer description: >- Um número inteiro que representa o número total de contas de canais públicos disponíveis. format: int32 Paging: type: object properties: next: $ref: '#/components/schemas/NextPage' prev: $ref: '#/components/schemas/PreviousPage' description: >- Representa as informações de paginação para navegar por uma lista de resultados na API. Ele fornece detalhes sobre como acessar o conjunto anterior ou seguinte de resultados. PublicChannelAccount: required: - active - archived - authorized - channelId - createdAt - id - inboxId - name type: object properties: active: type: boolean description: Um booleano que indica se a conta do canal está ativa no momento. archived: type: boolean description: Um booleano que indica se a conta do canal está arquivada. archivedAt: type: string description: >- A data e a hora em que a conta de canal foi arquivada, no formato ISO 8601. format: date-time authorized: type: boolean description: Um booleano que indica se a conta de canal está autorizada. channelId: type: string description: >- O identificador exclusivo do canal ao qual esta conta pertence, representado como uma string. createdAt: type: string description: >- A data e hora em que a conta do canal foi criada, no formato ISO 8601. format: date-time deliveryIdentifier: $ref: '#/components/schemas/PublicDeliveryIdentifier' id: type: string description: >- O identificador exclusivo para esta conta de canal, representado como uma string. inboxId: type: string description: >- O identificador exclusivo da caixa de entrada associada a esta conta de canal, representado como uma string. name: type: string description: O nome da conta de canal, representado como um string. Error: required: - category - correlationId - message type: object properties: category: type: string description: A categoria de erro context: type: object additionalProperties: type: array items: type: string description: Contexto sobre a condição do erro example: >- {invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]} correlationId: type: string description: >- Um identificador exclusivo para a solicitação. Inclua este valor em relatórios de erro ou tickets de suporte format: uuid example: aeb5f871-7f07-4993-9211-075dc63e7cbf errors: type: array description: mais informações sobre o erro items: $ref: '#/components/schemas/ErrorDetail' links: type: object additionalProperties: type: string description: >- Um mapa de nomes de links para URIs associados que contêm documentação sobre o erro ou as etapas de correção recomendadas message: type: string description: >- Uma mensagem legível por humanos que descreve o erro, juntamente com as etapas de correção, quando apropriado example: An error occurred subCategory: type: string description: >- Uma categoria específica que contém mais detalhes específicos sobre o erro description: >- Representa uma resposta de erro retornada pela API quando uma operação falha. Este componente é usado em vários endpoints para fornecer informações detalhadas sobre o erro encontrado. example: message: Invalid input (details will vary based on the error) correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf category: VALIDATION_ERROR links: knowledge-base: https://www.hubspot.com/products/service/knowledge-base NextPage: required: - after type: object properties: after: type: string description: Um token de cursor de paginação para recuperar páginas subsequentes. link: type: string description: >- Um URL que pode ser usado para recuperar os resultados da próxima página. description: >- Specifies the paging information needed to retrieve the next set of results in a paginated API response PreviousPage: required: - before type: object properties: before: type: string description: >- Um token de string que indica a posição antes da página atual na sequência de paginação. link: type: string description: >- Uma string de URL que pode ser usada para acessar a página de resultados anterior. description: >- specifies the paging information needed to retrieve the previous set of results in a paginated API response PublicDeliveryIdentifier: required: - type - value type: object properties: type: type: string description: >- Uma string que representa o tipo de identificador de entrega. Os valores válidos incluem 'HS_EMAIL_ADDRESS', 'HS_PHONE_NUMBER', 'HS_SHORT_CODE' e 'CHANNEL_SPECIFIC_OPAQUE_ID'. enum: - CHANNEL_SPECIFIC_OPAQUE_ID - HS_EMAIL_ADDRESS - HS_PHONE_NUMBER - HS_SHORT_CODE value: type: string description: >- Uma string que representa o valor associado ao tipo de identificador de entrega. ErrorDetail: required: - message type: object properties: code: type: string description: O código de status associado ao detalhe do erro context: type: object additionalProperties: type: array items: type: string description: Contexto sobre a condição do erro example: '{missingScopes=[scope1, scope2]}' in: type: string description: O nome do campo ou parâmetro no qual o erro foi encontrado. message: type: string description: >- Uma mensagem legível por humanos que descreve o erro, juntamente com as etapas de correção, quando apropriado subCategory: type: string description: >- Uma categoria específica que contém mais detalhes específicos sobre o erro description: >- Representa informações detalhadas sobre um erro ocorrido na API. Este componente é usado para fornecer contexto e detalhes adicionais sobre os erros, geralmente como parte de uma resposta de erro. responses: Error: description: An error occurred. content: '*/*': schema: $ref: '#/components/schemas/Error' securitySchemes: oauth2: type: oauth2 flows: authorizationCode: authorizationUrl: https://app.hubspot.com/oauth/authorize tokenUrl: https://api.hubapi.com/oauth/v1/token scopes: conversations.custom_channels.read: '' conversations.custom_channels.write: '' ````