How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HubSpot Conversations API

HubSpot Conversations — 18 operation(s) from HubSpot's published OpenAPI.

HubSpot Conversations API is one of 144 APIs that HubSpot publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 692 JSON Schema definitions.

Tagged areas include Conversations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, code examples, and 692 JSON Schemas.

This API exposes 18 operations across 14 paths, organized into 7 resource areas, and defines 68 schemas. It is described by OpenAPI 3.0.1, at version v3.

Requests are made against a single base URL, https://api.hubapi.com.

18 operations 14 paths 68 schemas 2 DELETE12 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
v3
Base URL
https://api.hubapi.com
Authentication
API Key, OAuth 2.0, API Key, API Key
Resource Areas
7

Authentication & Security 4

HubSpot Conversations API declares 4 security schemes for authenticating requests. An API key is passed in the query as hapikey (developer_hapikey). It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 2 scopes. An API key is passed in the header as private-app (private_apps). An API key is passed in the header as private-app-legacy (private_apps_legacy).

Paths & Operations 18

Across 14 paths, the API surfaces 18 operations — 2 DELETE, 12 GET, 1 PATCH, 2 POST, 1 PUT. They span 7 resource areas: Basic, Actors, Channel accounts, Channels, Inboxes, Threads, Messages. Each is listed below with its method, path, parameters, and response codes.

Basic 2
PUT
/conversations/conversations/v3/threads/{threadId}/assignee
put-/conversations/conversations/v3/threads/{threadId}/assignee_/conversations/conversations/v3/threads/{threadId}/assignee 1 param body → 200default
DELETE
/conversations/conversations/v3/threads/{threadId}/assignee
delete-/conversations/conversations/v3/threads/{threadId}/assignee_/conversations/conversations/v3/threads/{threadId}/assignee 1 param → 204default
Actors 2
POST
/conversations/v3/conversations/actors/batch/read
Get a group of actors
post-/conversations/v3/conversations/actors/batch/read 1 param body → 200207default
GET
/conversations/v3/conversations/actors/{actorId}
Get a single actor
get-/conversations/v3/conversations/actors/{actorId} 2 params → 200default
Channel accounts 2
GET
/conversations/v3/conversations/channel-accounts
Get channel accounts
get-/conversations/v3/conversations/channel-accounts 7 params → 200default
GET
/conversations/v3/conversations/channel-accounts/{channelAccountId}
Get a single channel account
get-/conversations/v3/conversations/channel-accounts/{channelAccountId} 2 params → 200default
Channels 2
GET
/conversations/v3/conversations/channels
Get channels
get-/conversations/v3/conversations/channels 4 params → 200default
GET
/conversations/v3/conversations/channels/{channelId}
Get a single channel
get-/conversations/v3/conversations/channels/{channelId} 1 param → 200default
Inboxes 2
GET
/conversations/v3/conversations/inboxes
Get conversations inboxes
get-/conversations/v3/conversations/inboxes 5 params → 200default
GET
/conversations/v3/conversations/inboxes/{inboxId}
Get a single conversations inbox
get-/conversations/v3/conversations/inboxes/{inboxId} 2 params → 200default
Threads 6
GET
/conversations/v3/conversations/threads
Get threads
get-/conversations/v3/conversations/threads 11 params → 200default
GET
/conversations/v3/conversations/threads/{threadId}
Get a single thread
get-/conversations/v3/conversations/threads/{threadId} 4 params → 200default
DELETE
/conversations/v3/conversations/threads/{threadId}
Archives a thread
delete-/conversations/v3/conversations/threads/{threadId} 1 param → 204default
PATCH
/conversations/v3/conversations/threads/{threadId}
Update a thread
patch-/conversations/v3/conversations/threads/{threadId} 2 params body → 200default
GET
/conversations/v3/conversations/threads/{threadId}/messages
Get message history for a thread
get-/conversations/v3/conversations/threads/{threadId}/messages 6 params → 200default
POST
/conversations/v3/conversations/threads/{threadId}/messages
Send a message to a thread
post-/conversations/v3/conversations/threads/{threadId}/messages 1 param body → 201default
Messages 2
GET
/conversations/v3/conversations/threads/{threadId}/messages/{messageId}
Get a single message
get-/conversations/v3/conversations/threads/{threadId}/messages/{messageId} 3 params → 200default
GET
/conversations/v3/conversations/threads/{threadId}/messages/{messageId}/original-content
Get the original content of a single message
get-/conversations/v3/conversations/threads/{threadId}/messages/{messageId}/original-content 3 params → 200default

Schemas 68

The contract defines 68 schemas that model the data the API accepts and returns. The most detailed are PublicConversationsMessage (20 properties), PublicThread (15 properties), PublicWelcomeMessage (14 properties), PublicComment (13 properties). Each schema is shown below with its type and property counts.

AgentActor
object
5 properties 2 required
BatchInputString
object
1 property 1 required
BatchResponsePublicActor
object
6 properties 4 required
BatchResponsePublicActorWithErrors
object
8 properties 4 required
BotActor
object
4 properties 2 required
CollectionResponsePublicMessageForwardPaging
object
2 properties 1 required
CollectionResponsePublicThreadForwardPaging
object
2 properties 1 required
CollectionResponseWithTotalPublicChannel
object
3 properties 2 required
CollectionResponseWithTotalPublicChannelAccount
object
3 properties 2 required
CollectionResponseWithTotalPublicInbox
object
3 properties 2 required
ContactAddress
object
7 properties
ContactEmail
object
2 properties 1 required
ContactName
object
5 properties
ContactOrg
object
3 properties
ContactPhone
object
2 properties 1 required
ContactProfile
object
6 properties 4 required
ContactUrl
object
2 properties 1 required
EmailActor
object
3 properties 3 required
Error
object
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…
7 properties 3 required
ErrorDetail
object
Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typic…
5 properties 1 required
ForwardPaging
object
Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page.
1 property
IntegratorActor
object
4 properties 3 required
LlmActor
object
4 properties 2 required
NextPage
object
Specifies the paging information needed to retrieve the next set of results in a paginated API response
2 properties 1 required
Paging
object
2 properties
PreviousPage
object
specifies the paging information needed to retrieve the previous set of results in a paginated API response
2 properties 1 required
PublicActor
PublicAssignmentMessage
object
12 properties 9 required
PublicChannel
object
2 properties 2 required
PublicChannelAccount
object
10 properties 8 required
PublicClient
object
2 properties 1 required
PublicComment
object
13 properties 12 required
PublicCommentEgg
object
4 properties 3 required
PublicContact
object
2 properties 2 required
PublicConversationsMessage
object
20 properties 15 required
PublicConversationsMessageEgg
object
9 properties 7 required
PublicDeliveryIdentifier
object
2 properties 2 required
PublicFile
object
5 properties 3 required
PublicFileEgg
object
2 properties 2 required
PublicInbox
object
7 properties 6 required
PublicLocation
object
6 properties 3 required
PublicMessage
PublicMessageContent
object
2 properties
PublicMessageEgg
PublicMessageFailureDetails
object
2 properties 1 required
PublicMessageHeader
object
3 properties 1 required
PublicMessageStatus
object
2 properties 1 required
PublicQuickReplies
object
4 properties 4 required
PublicQuickRepliesEgg
object
2 properties 2 required
PublicRecipient
object
4 properties 1 required
PublicRecipientEgg
object
5 properties 1 required
PublicSender
object
4 properties
PublicSocialMediaEgg
object
2 properties 2 required
PublicSocialMetadataAttachment
object
2 properties 2 required
PublicThread
object
15 properties 9 required
PublicThreadAssignRequest
object
1 property 1 required
PublicThreadAssociations
object
1 property
PublicThreadInboxChange
object
12 properties 11 required
PublicThreadStatusChange
object
11 properties 10 required
PublicThreadUpdateRequest
object
2 properties
PublicUnsupportedContent
object
1 property 1 required
PublicWelcomeMessage
object
14 properties 12 required
PublicWhatsAppTemplateMetadata
object
6 properties 3 required
QuickReply
object
3 properties 2 required
SocialMetadata
object
7 properties 1 required
StandardError
object
Represents a standard error response in the HubSpot API, providing detailed information about an error that occurred during an API request.
8 properties 6 required
SystemActor
object
2 properties 2 required
VisitorActor
object
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hubspot-conversations-conversations-api-openapi.yml Raw ↑

Other APIs HubSpot publishes across the network.

HubSpot URL Redirects API
HubSpot Pipelines API
HubSpot Products API
HubSpot Line Items API
HubSpot Quotes API
HubSpot CRM Properties API
HubSpot Owners API
HubSpot CRM Imports API
HubSpot Custom Objects API
HubSpot Marketing Events API
HubSpot Forms API
HubSpot Workflows API
Where this information came from

This is an independent, third-party profile of HubSpot Conversations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.