HubSpot: Retrieve details of a specific export by its unique ID

← Exports operations · Get started

Operation hubspot.exports_get_export

Provider route: GET /crm/exports/2026-09/export/{exportId}. 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"]["getExport"]>[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.getExport(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(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.exportId	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 Retrieve details of a specific export by its unique ID — response body

Referenced models: Retrieve details of a specific export by its unique ID — response body

Schemas

Retrieve details of a specific export by its unique ID — response body

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	string	Required within parent	The timestamp when the export was created, in ISO 8601 format. Format: date-time
exportName	string	Optional	The name assigned to the export.
exportState	string	Required within parent	The current state of the export process. Known values: CANCELED, CONFLICT, DEFERRED, DELETED, DONE, ENQUEUED, FAILED, PENDING_APPROVAL, PROCESSING
exportType	string	Required within parent	The type of export, which can be either VIEW or LIST. Known values: LIST, VIEW
id	string	Required within parent	The unique ID of the export.
objectProperties	array	Required within parent	The list of properties exported for the associated object.
objectProperties[]	string	Each item
objectType	string	Required within parent	The associated CRM object being exported.
recordCount	JSON	Optional
recordCount (anyOf 1)	integer	Alternative	The total number of records included in the export. Format: int32
recordCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedAt	string	Required within parent	The timestamp when the export was last updated, in ISO 8601 format. Format: date-time

Policy, approvals and errors

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