Skip to content

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.

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 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.notetaker.get_conversation_recap(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.objectIdstringRequired within parent
path.objectTypeIdstringRequired within parent

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve conversation recap data — response body

Referenced models: Retrieve conversation recap data — response body

5 more schemas are linked from the tables above, on the schema pages.

Retrieve conversation recap data — response body
FieldTypePresenceDescription and constraints
$objectRoot
actionItemsModelRequired within parentExpand Retrieve conversation recap data — response body — action Items
callStatsModelRequired within parentExpand Retrieve conversation recap data — response body — call Stats
notesModelRequired within parentExpand Retrieve conversation recap data — response body — notes
participantsModelRequired within parentExpand Retrieve conversation recap data — response body — participants
questionsAskedModelRequired within parentExpand Retrieve conversation recap data — response body — questions Asked
recordingUrlModelRequired within parentExpand Retrieve conversation recap data — response body — recording Url
summaryModelOptionalExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
errorModelOptionalExpand Retrieve conversation recap data — response body — notes error
itemsarrayRequired within parentThe list of action items extracted from the conversation. Populated when status is SUCCEEDED; empty otherwise.
items[]ModelEach itemExpand Retrieve conversation recap data — response body — action Items items item
statusstringRequired within parentThe 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
FieldTypePresenceDescription and constraints
$objectRoot
durationMsJSONOptional
durationMs (anyOf 1)integerAlternativeThe length of the recorded conversation in milliseconds.
Format: int64
durationMs (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
errorModelOptionalExpand Retrieve conversation recap data — response body — notes error
hasTranscriptbooleanRequired within parentWhether a transcript for a conversation is found.
ownerTalkTimePercentagestringOptionalThe percentage of talk-time attributed to the owner participant.
statusstringRequired within parentThe 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
FieldTypePresenceDescription and constraints
$objectRoot
errorModelOptionalExpand Retrieve conversation recap data — response body — notes error
statusstringRequired within parentThe status of fetching the notes. Either SUCCEEDED, NOT_FOUND, or FAILED.
Known values: FAILED, IN_PROGRESS, NOT_FOUND, NOT_SUPPORTED, SUCCEEDED
valuestringOptionalA 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
FieldTypePresenceDescription and constraints
$objectRoot
errorModelOptionalExpand Retrieve conversation recap data — response body — notes error
itemsarrayRequired within parentAn array of participant information objects, each containing details about a participant in the conversation.
items[]ModelEach itemExpand Retrieve conversation recap data — response body — participants items item
statusstringRequired within parentThe 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
FieldTypePresenceDescription and constraints
$objectRoot
errorModelOptionalExpand Retrieve conversation recap data — response body — notes error
questionsAndAnswersarrayRequired within parentA list of question and answer pairs.
questionsAndAnswers[]ModelEach itemExpand Retrieve conversation recap data — response body — questions Asked questions And Answers item
statusstringRequired within parentThe 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
FieldTypePresenceDescription and constraints
$objectRoot
errorModelOptionalExpand Retrieve conversation recap data — response body — notes error
statusstringRequired within parentThe status of creating a URL. Either FAILED, NOT_FOUND, or SUCCEEDED.
Known values: FAILED, IN_PROGRESS, NOT_FOUND, NOT_SUPPORTED, SUCCEEDED
valuestringOptionalThe URL of the recording as a string.

Referenced models: Retrieve conversation recap data — response body — notes error

Retrieve conversation recap data — response body — summary
FieldTypePresenceDescription and constraints
$objectRoot
errorModelOptionalExpand Retrieve conversation recap data — response body — notes error
statusstringRequired within parentThe 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
valuestringOptionalThe 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
FieldTypePresenceDescription and constraints
$objectRoot
assigneestringOptionalA string indicating the individual assigned to the action item. This property is optional.
assigneeObjectIdstringOptionalThe id of the HubSpot user or contact assigned to this action item, if found. This property is optional.
idstringRequired within parentThe unique identifier for the action item, represented as a string.
titlestringRequired within parentA string representing the title or main description of the action item. This property is required.

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"]

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.