Skip to content

HubSpot: List threads

HubSpot conversations.getThreads: arguments, response, policy and SDK examples.

← Conversations operations · Get started

Operation hubspot.conversations_get_threads

Provider route: GET /conversations/conversations/2026-09/threads. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/hubspot with npm, or alter-sdk-hubspot with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HubSpotIntegration } from "@alter-ai/hubspot";
async function execute(input: Parameters<HubSpotIntegration["conversations"]["getThreads"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new HubSpotIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.conversations.getThreads(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_hubspot import HubSpotIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = HubSpotIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.conversations.get_threads(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.afterstringOptional
query.archivedbooleanOptional
query.associatedContactIdintegerOptionalFormat: int64
query.associatedTicketIdintegerOptionalFormat: int64
query.associationarrayOptional
query.association[]stringEach itemOne of: TICKET
query.inboxIdarrayOptional
query.inboxId[]integerEach itemFormat: int32
query.latestMessageTimestampAfterstringOptionalFormat: date-time
query.limitintegerOptionalFormat: int32
query.propertystringOptional
query.sortarrayOptional
query.sort[]stringEach item
query.threadStatusstringOptionalOne of: CLOSED, OPEN

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand List threads — response body

Referenced models: List threads — response body

List threads — response body
FieldTypePresenceDescription and constraints
$objectRoot
pagingModelOptionalExpand List threads — response body — paging
resultsarrayRequired within parentAn array of PublicThread objects, representing the individual threads in the collection.
results[]ModelEach itemExpand Update thread — response body

Referenced models: List threads — response body — paging, Update thread — response body

List threads — response body — paging
FieldTypePresenceDescription and constraints
$objectRootPaging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page.
nextModelOptionalExpand List Inboxes — response body — paging next

Referenced models: List Inboxes — response body — paging next

Update thread — response body
FieldTypePresenceDescription and constraints
$objectRoot
archivedbooleanRequired within parentA boolean indicating whether the thread is archived.
assignedTostringOptionalThe identifier of the user to whom the thread is assigned.
associatedContactIdstringRequired within parentThe identifier of the contact associated with the thread.
closedAtstringOptionalThe date and time when the thread was closed, in ISO 8601 format.
Format: date-time
createdAtstringRequired within parentThe date and time when the thread was created, in ISO 8601 format.
Format: date-time
idstringRequired within parentThe unique identifier for the conversation thread.
inboxIdstringRequired within parentThe identifier of the inbox where the thread is located.
latestMessageReceivedTimestampstringOptionalThe date and time when the latest message was received, in ISO 8601 format.
Format: date-time
latestMessageSentTimestampstringOptionalThe date and time when the latest message was sent, in ISO 8601 format.
Format: date-time
latestMessageTimestampstringOptionalThe date and time of the latest message in the thread, in ISO 8601 format.
Format: date-time
originalChannelAccountIdstringRequired within parentThe identifier of the original channel account associated with the thread.
originalChannelIdstringRequired within parentThe identifier of the original channel where the thread was initiated.
spambooleanRequired within parentA boolean indicating whether the thread is marked as spam.
statusstringRequired within parentThe current status of the thread. Valid values include 'OPEN' and 'CLOSED'.
Known values: CLOSED, OPEN
threadAssociationsModelOptionalExpand Update thread — response body — thread Associations

Referenced models: Update thread — response body — thread Associations

List Inboxes — response body — paging next
FieldTypePresenceDescription and constraints
$objectRootSpecifies the paging information needed to retrieve the next set of results in a paginated API response
afterstringRequired within parentA string token used to fetch the next set of results in a paginated response.
linkstringOptionalA string containing the URL link to the next page of results.
Update thread — response body — thread Associations
FieldTypePresenceDescription and constraints
$objectRoot
associatedTicketIdstringOptionalThe unique identifier for the associated ticket, represented as a string.

SDK function policy ID: hubspot.conversations_get_threads. Catalog operation: conversations_get_threads. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["conversations.read"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.