;
};
## OpenAPI
````yaml specs/legacy/v3/conversations-custom-channels-v3.json GET /conversations/custom-channels/v3
openapi: 3.0.1
info:
title: Conversations Custom Channels
description: Basepom for all HubSpot Projects
version: v3
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-related-documentation:
- name: Custom Channels Guide
url: >-
https://developers.hubspot.com/docs/guides/api/conversations/create-custom-channels
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/v3:
get:
tags:
- Basic
operationId: get-/conversations/custom-channels/v3_/conversations/custom-channels/v3
parameters:
- name: after
in: query
required: false
style: form
explode: true
schema:
type: string
- name: defaultPageLength
in: query
required: false
style: form
explode: true
schema:
type: integer
format: int32
- name: limit
in: query
required: false
style: form
explode: true
schema:
type: integer
format: int32
- name: sort
in: query
required: false
style: form
explode: true
schema:
type: array
items:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: >-
#/components/schemas/CollectionResponseWithTotalPublicChannelIntegrationChannel
default:
$ref: '#/components/responses/Error'
description: ''
security: []
components:
schemas:
CollectionResponseWithTotalPublicChannelIntegrationChannel:
required:
- results
- total
type: object
properties:
paging:
$ref: '#/components/schemas/Paging'
results:
type: array
items:
$ref: '#/components/schemas/PublicChannelIntegrationChannel'
total:
type: integer
format: int32
Paging:
type: object
properties:
next:
$ref: '#/components/schemas/NextPage'
prev:
$ref: '#/components/schemas/PreviousPage'
PublicChannelIntegrationChannel:
required:
- capabilities
- createdAt
- id
- name
type: object
properties:
capabilities:
type: object
additionalProperties:
type: object
properties: {}
channelAccountConnectionRedirectUrl:
type: string
channelDescription:
type: string
channelLogoUrl:
type: string
createdAt:
type: string
format: date-time
id:
type: string
name:
type: string
webhookUrl:
type: string
Error:
required:
- category
- correlationId
- message
type: object
properties:
category:
type: string
description: The error category
context:
type: object
additionalProperties:
type: array
items:
type: string
description: Context about the error condition
example: >-
{invalidPropertyName=[propertyValue], missingScopes=[scope1,
scope2]}
correlationId:
type: string
description: >-
A unique identifier for the request. Include this value with any
error reports or support tickets
format: uuid
example: aeb5f871-7f07-4993-9211-075dc63e7cbf
errors:
type: array
description: further information about the error
items:
$ref: '#/components/schemas/ErrorDetail'
links:
type: object
additionalProperties:
type: string
description: >-
A map of link names to associated URIs containing documentation
about the error or recommended remediation steps
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate
example: An error occurred
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error
description: >-
Represents an error response returned by the API when an operation
fails. This component is used in various endpoints to provide detailed
information about the error encountered.
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: A paging cursor token for retrieving subsequent pages.
link:
type: string
description: A URL that can be used to retrieve the next page results.
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: A paging cursor token for retrieving previous pages.
link:
type: string
description: A URL that can be used to retrieve the previous pages' results.
description: >-
specifies the paging information needed to retrieve the previous set of
results in a paginated API response
ErrorDetail:
required:
- message
type: object
properties:
code:
type: string
description: The status code associated with the error detail
context:
type: object
additionalProperties:
type: array
items:
type: string
description: Context about the error condition
example: '{missingScopes=[scope1, scope2]}'
in:
type: string
description: The name of the field or parameter in which the error was found.
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error
description: >-
Represents detailed information about an error that occurred in the API.
This component is used to provide additional context and specifics about
errors, typically as part of an error response.
responses:
Error:
description: An error occurred.
content:
'*/*':
schema:
$ref: '#/components/schemas/Error'
````
{product.name} -
{product.level}
)}