Skip to content

HubSpot: Retrieve transcript

HubSpot transcriptions.getTranscript: arguments, response, policy and SDK examples.

← Transcriptions operations · Get started

Operation hubspot.transcriptions_get_transcript

Provider route: GET /crm/extensions/calling/2026-09/transcripts/{transcriptId}. 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["transcriptions"]["getTranscript"]>[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.transcriptions.getTranscript(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.transcriptions.get_transcript(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.transcriptIdstringRequired 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 transcript — response body

Referenced models: Retrieve transcript — response body

Retrieve transcript — response body
FieldTypePresenceDescription and constraints
$objectRoot
createdAtstringRequired within parentThe date and time when this transcript was created, in ISO 8601 date-time format.
Format: date-time
engagementIdJSONRequired within parent
engagementId (anyOf 1)integerAlternativeThe unique identifier for the engagement associated with this transcript. It is an integer in int64 format.
Format: int64
engagementId (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
idstringRequired within parentThe unique identifier for this transcript, represented as a string.
transcriptSourcestringRequired within parentIndicates the origin of the transcript, which can be either 'HUBSPOT_GENERATED' or 'INTEGRATOR_GENERATED'.
Known values: HUBSPOT_GENERATED, INTEGRATOR_GENERATED
transcriptUtterancesarrayRequired within parentAn array of utterances that make up the transcript. Each utterance contains details such as text, timing, and speaker information.
transcriptUtterances[]ModelEach itemExpand Retrieve transcript — response body — transcript Utterances item
updatedAtstringRequired within parentThe date and time when this transcript was last updated, in ISO 8601 date-time format.
Format: date-time

Referenced models: Retrieve transcript — response body — transcript Utterances item

Retrieve transcript — response body — transcript Utterances item
FieldTypePresenceDescription and constraints
$objectRoot
endTimeMillisJSONRequired within parent
endTimeMillis (anyOf 1)integerAlternativeThe end time of the utterance, given as a Unix timestamp in milliseconds. It marks when the utterance ended.
Format: int64
endTimeMillis (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
idstringRequired within parentA unique identifier for the utterance, represented as a string.
languageCodestringOptionalThe language code of the utterance, represented as a string. This indicates the language in which the text was spoken.
speakerModelOptionalExpand Retrieve transcript — response body — transcript Utterances item speaker
startTimeMillisJSONRequired within parent
startTimeMillis (anyOf 1)integerAlternativeThe start time of the utterance, given as a Unix timestamp in milliseconds. It marks when the utterance began.
Format: int64
startTimeMillis (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
textstringRequired within parentThe spoken text of the utterance. It is a string representing the actual words spoken.

Referenced models: Retrieve transcript — response body — transcript Utterances item speaker

Retrieve transcript — response body — transcript Utterances item speaker
FieldTypePresenceDescription and constraints
$objectRoot
emailstringOptionalThe email address of the speaker, represented as a string.
idstringRequired within parentA unique identifier for the speaker, represented as a string.
namestringRequired within parentThe name of the speaker, represented as a string.

SDK function policy ID: hubspot.transcriptions_get_transcript. Catalog operation: transcriptions_get_transcript. 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.extensions_calling_transcripts.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.