HubSpot: Retrieve conversation recap data
HubSpot notetaker.getConversationRecap: arguments, response, policy and SDK examples.
← Notetaker operations · Get started
Operation hubspot.notetaker_get_conversation_recap
Provider route: GET /notetaker/2026-09/conversation/recap/{objectTypeId}/{objectId}. 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["notetaker"]["getConversationRecap"]>[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.notetaker.getConversationRecap(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.notetaker.get_conversation_recap(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.objectId | string | Required within parent | |
path.objectTypeId | string | Required within parent |
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 Retrieve conversation recap data — response body |
Referenced models: Retrieve conversation recap data — response body
Schemas
Section titled “Schemas”5 more schemas are linked from the tables above, on the schema pages.
Retrieve conversation recap data — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
actionItems | Model | Required within parent | Expand Retrieve conversation recap data — response body — action Items |
callStats | Model | Required within parent | Expand Retrieve conversation recap data — response body — call Stats |
notes | Model | Required within parent | Expand Retrieve conversation recap data — response body — notes |
participants | Model | Required within parent | Expand Retrieve conversation recap data — response body — participants |
questionsAsked | Model | Required within parent | Expand Retrieve conversation recap data — response body — questions Asked |
recordingUrl | Model | Required within parent | Expand Retrieve conversation recap data — response body — recording Url |
summary | Model | Optional | Expand Retrieve conversation recap data — response body — summary |
Referenced models: Retrieve conversation recap data — response body — action Items, Retrieve conversation recap data — response body — call Stats, Retrieve conversation recap data — response body — notes, Retrieve conversation recap data — response body — participants, Retrieve conversation recap data — response body — questions Asked, Retrieve conversation recap data — response body — recording Url, Retrieve conversation recap data — response body — summary
Retrieve conversation recap data — response body — action Items
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error | Model | Optional | Expand Retrieve conversation recap data — response body — notes error |
items | array | Required within parent | The list of action items extracted from the conversation. Populated when status is SUCCEEDED; empty otherwise. |
items[] | Model | Each item | Expand Retrieve conversation recap data — response body — action Items items item |
status | string | Required within parent | The current state of action item generation. SUCCEEDED — action items are available. NOT_FOUND — no action items have been generated for this engagement. IN_PROGRESS — generation is currently underway. FAILED — an error occurred while retrieving action items. Known values: FAILED, IN_PROGRESS, NOT_FOUND, NOT_SUPPORTED, SUCCEEDED |
Referenced models: Retrieve conversation recap data — response body — action Items items item, Retrieve conversation recap data — response body — notes error
Retrieve conversation recap data — response body — call Stats
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
durationMs | JSON | Optional | |
durationMs (anyOf 1) | integer | Alternative | The length of the recorded conversation in milliseconds. Format: int64 |
durationMs (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
error | Model | Optional | Expand Retrieve conversation recap data — response body — notes error |
hasTranscript | boolean | Required within parent | Whether a transcript for a conversation is found. |
ownerTalkTimePercentage | string | Optional | The percentage of talk-time attributed to the owner participant. |
status | string | Required within parent | The status of fetching call stats. Either SUCCEEDED, NOT_FOUND, or FAILED. Known values: FAILED, IN_PROGRESS, NOT_FOUND, NOT_SUPPORTED, SUCCEEDED |
Referenced models: Retrieve conversation recap data — response body — notes error
Retrieve conversation recap data — response body — notes
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error | Model | Optional | Expand Retrieve conversation recap data — response body — notes error |
status | string | Required within parent | The status of fetching the notes. Either SUCCEEDED, NOT_FOUND, or FAILED. Known values: FAILED, IN_PROGRESS, NOT_FOUND, NOT_SUPPORTED, SUCCEEDED |
value | string | Optional | A string containing the notes from the conversation recap. |
Referenced models: Retrieve conversation recap data — response body — notes error
Retrieve conversation recap data — response body — participants
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error | Model | Optional | Expand Retrieve conversation recap data — response body — notes error |
items | array | Required within parent | An array of participant information objects, each containing details about a participant in the conversation. |
items[] | Model | Each item | Expand Retrieve conversation recap data — response body — participants items item |
status | string | Required within parent | The status of fetching participants. Either SUCCEEDED or FAILED. Known values: FAILED, IN_PROGRESS, NOT_FOUND, NOT_SUPPORTED, SUCCEEDED |
Referenced models: Retrieve conversation recap data — response body — notes error, Retrieve conversation recap data — response body — participants items item
Retrieve conversation recap data — response body — questions Asked
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error | Model | Optional | Expand Retrieve conversation recap data — response body — notes error |
questionsAndAnswers | array | Required within parent | A list of question and answer pairs. |
questionsAndAnswers[] | Model | Each item | Expand Retrieve conversation recap data — response body — questions Asked questions And Answers item |
status | string | Required within parent | The status of fetching questions and answers. Either FAILED, NOT_FOUND, or SUCCEEDED. Known values: FAILED, IN_PROGRESS, NOT_FOUND, NOT_SUPPORTED, SUCCEEDED |
Referenced models: Retrieve conversation recap data — response body — notes error, Retrieve conversation recap data — response body — questions Asked questions And Answers item
Retrieve conversation recap data — response body — recording Url
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error | Model | Optional | Expand Retrieve conversation recap data — response body — notes error |
status | string | Required within parent | The status of creating a URL. Either FAILED, NOT_FOUND, or SUCCEEDED. Known values: FAILED, IN_PROGRESS, NOT_FOUND, NOT_SUPPORTED, SUCCEEDED |
value | string | Optional | The URL of the recording as a string. |
Referenced models: Retrieve conversation recap data — response body — notes error
Retrieve conversation recap data — response body — summary
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error | Model | Optional | Expand Retrieve conversation recap data — response body — notes error |
status | string | Required within parent | The current state of summary generation. SUCCEEDED — summary is available. NOT_FOUND — no summary has been generated for this engagement. FAILED — an error occurred while retrieving the summary. Known values: FAILED, IN_PROGRESS, NOT_FOUND, NOT_SUPPORTED, SUCCEEDED |
value | string | Optional | The AI-generated summary text for the conversation. Present when status is SUCCEEDED; absent otherwise. |
Referenced models: Retrieve conversation recap data — response body — notes error
Retrieve conversation recap data — response body — action Items items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
assignee | string | Optional | A string indicating the individual assigned to the action item. This property is optional. |
assigneeObjectId | string | Optional | The id of the HubSpot user or contact assigned to this action item, if found. This property is optional. |
id | string | Required within parent | The unique identifier for the action item, represented as a string. |
title | string | Required within parent | A string representing the title or main description of the action item. This property is required. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: hubspot.notetaker_get_conversation_recap. Catalog operation: notetaker_get_conversation_recap. 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: ["crm.objects.contacts.read"]