Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HubSpot Threads API

Operations for creating, retrieving, updating, and archiving conversation threads.

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

This API exposes 652 JSON Schema definitions.

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

This API exposes 4 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.1.0, at version 3.0.0.

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

4 operations 2 paths 7 schemas 1 DELETE2 GET1 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.0.0
Base URL
https://api.example.com
Authentication
OAuth 2.0
License
Resource Areas
1

Authentication & Security 1

HubSpot Threads API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 1 scope.

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 PATCH. Each is listed below with its method, path, parameters, and response codes.

Threads 4

Operations for creating, retrieving, updating, and archiving conversation threads.

GET
/conversations/v3/conversations/threads
Hubspot List Conversation Threads
listThreads 6 params → 200default
GET
/conversations/v3/conversations/threads/{threadId}
Hubspot Retrieve a Thread
getThreadById 4 params → 200default
PATCH
/conversations/v3/conversations/threads/{threadId}
Hubspot Update a Thread
updateThread 1 param body → 200default
DELETE
/conversations/v3/conversations/threads/{threadId}
Hubspot Archive a Thread
archiveThread 1 param → 204default

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Thread (14 properties), Error (7 properties), ErrorDetail (5 properties), PagingNext (2 properties). Each schema is shown below with its type and property counts.

ThreadCollection
object
Paginated collection of conversation threads
2 properties 1 required
ErrorDetail
object
Detailed information about a specific error.
5 properties 1 required
Error
object
Standard error response structure.
7 properties 3 required
UpdateThreadRequest
object
Request payload for updating a thread's properties.
2 properties
Thread
object
Represents a conversation thread containing messages between participants.
14 properties 4 required
Paging
object
Pagination information for list responses.
1 property
PagingNext
object
Pagination cursor information for retrieving the next page.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hubspot-threads-api-openapi.yml Raw ↑

Other APIs HubSpot publishes across the network.

HubSpot Posts API
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