HubSpot: Get the status of the export including the URL to download the file

← Exports operations · Get started

Operation hubspot.exports_get_export_status

Provider route: GET /crm/exports/2026-09/export/async/tasks/{taskId}/status. Alter supplies the connection’s credentials and routing.

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["exports"]["getExportStatus"]>[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.exports.getExportStatus(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.exports.get_export_status(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.taskId	integer	Required within parent	Format: int64

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 Get the status of the export including the URL to download the file — response body

Referenced models: Get the status of the export including the URL to download the file — response body

Schemas

Get the status of the export including the URL to download the file — response body

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	The timestamp when the export was completed, in ISO 8601 format. Format: date-time
errors	array	Optional	An array of StandardError objects detailing any errors that occurred during the export task.
errors[]	Model	Each item	Expand Get the status of the export including the URL to download the file — response body — errors item
links	object	Optional	A collection of related links associated with the export. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The number of errors encountered during the export process. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	The timestamp when the export request was made, in ISO 8601 format. Format: date-time
result	string	Optional	The URL of the resulting file if the export status is COMPLETE.
startedAt	string	Required within parent	The timestamp when the export process started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the export, which can be PENDING, PROCESSING, COMPLETE or CANCELED. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Get the status of the export including the URL to download the file — response body — errors item

Get the status of the export including the URL to download the file — response body — errors item

Field	Type	Presence	Description and constraints
$	object	Root	Ye olde error
category	string	Required within parent	A string indicating the general category of the error.
context	object	Required within parent	Context about the error condition Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
errors	array	Required within parent	An array of ErrorDetail objects providing further information about the error.
errors[]	Model	Each item	Expand Batch insert events — response body — errors item errors item
id	string	Optional	A string that uniquely identifies this error instance.
links	object	Required within parent	An object mapping link names to associated URIs that contain documentation about the error or recommended remediation steps. Additional keys: see wildcard field
links.*	string	Additional keys
message	string	Required within parent	A human readable message describing the error along with remediation steps where appropriate
status	string	Required within parent	A string representing the status of the error.
subCategory	object	Optional	A specific category that contains more specific detail about the error

Referenced models: Batch insert events — response body — errors item errors item

Batch insert events — response body — errors item errors item

Field	Type	Presence	Description and constraints
$	object	Root	Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response.
code	string	Optional	The status code associated with the error detail
context	object	Optional	Context about the error condition Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
in	string	Optional	The name of the field or parameter in which the error was found.
message	string	Required within parent	A human readable message describing the error along with remediation steps where appropriate
subCategory	string	Optional	A specific category that contains more specific detail about the error

Policy, approvals and errors

SDK function policy ID: hubspot.exports_get_export_status. Catalog operation: exports_get_export_status. 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.export"]

Official provider source