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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.after | string | Optional | |
query.archived | boolean | Optional | |
query.associatedContactId | integer | Optional | Format: int64 |
query.associatedTicketId | integer | Optional | Format: int64 |
query.association | array | Optional | |
query.association[] | string | Each item | One of: TICKET |
query.inboxId | array | Optional | |
query.inboxId[] | integer | Each item | Format: int32 |
query.latestMessageTimestampAfter | string | Optional | Format: date-time |
query.limit | integer | Optional | Format: int32 |
query.property | string | Optional | |
query.sort | array | Optional | |
query.sort[] | string | Each item | |
query.threadStatus | string | Optional | One of: CLOSED, OPEN |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand List threads — response body |
Referenced models: List threads — response body
Schemas
Section titled “Schemas”List threads — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
paging | Model | Optional | Expand List threads — response body — paging |
results | array | Required within parent | An array of PublicThread objects, representing the individual threads in the collection. |
results[] | Model | Each item | Expand Update thread — response body |
Referenced models: List threads — response body — paging, Update thread — response body
List threads — response body — paging
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page. |
next | Model | Optional | Expand List Inboxes — response body — paging next |
Referenced models: List Inboxes — response body — paging next
Update thread — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
archived | boolean | Required within parent | A boolean indicating whether the thread is archived. |
assignedTo | string | Optional | The identifier of the user to whom the thread is assigned. |
associatedContactId | string | Required within parent | The identifier of the contact associated with the thread. |
closedAt | string | Optional | The date and time when the thread was closed, in ISO 8601 format. Format: date-time |
createdAt | string | Required within parent | The date and time when the thread was created, in ISO 8601 format. Format: date-time |
id | string | Required within parent | The unique identifier for the conversation thread. |
inboxId | string | Required within parent | The identifier of the inbox where the thread is located. |
latestMessageReceivedTimestamp | string | Optional | The date and time when the latest message was received, in ISO 8601 format. Format: date-time |
latestMessageSentTimestamp | string | Optional | The date and time when the latest message was sent, in ISO 8601 format. Format: date-time |
latestMessageTimestamp | string | Optional | The date and time of the latest message in the thread, in ISO 8601 format. Format: date-time |
originalChannelAccountId | string | Required within parent | The identifier of the original channel account associated with the thread. |
originalChannelId | string | Required within parent | The identifier of the original channel where the thread was initiated. |
spam | boolean | Required within parent | A boolean indicating whether the thread is marked as spam. |
status | string | Required within parent | The current status of the thread. Valid values include 'OPEN' and 'CLOSED'. Known values: CLOSED, OPEN |
threadAssociations | Model | Optional | Expand Update thread — response body — thread Associations |
Referenced models: Update thread — response body — thread Associations
List Inboxes — response body — paging next
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Specifies the paging information needed to retrieve the next set of results in a paginated API response |
after | string | Required within parent | A string token used to fetch the next set of results in a paginated response. |
link | string | Optional | A string containing the URL link to the next page of results. |
Update thread — response body — thread Associations
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
associatedTicketId | string | Optional | The unique identifier for the associated ticket, represented as a string. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"]