HubSpot: Start an export

← Exports operations · Get started

Operation hubspot.exports_create_export

Provider route: POST /crm/exports/2026-09/export/async. 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"]["createExport"]>[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.createExport(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.create_export(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	Model	Required within parent	Expand Start an export — request body — body

Referenced models: Start an export — request body — body

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 Start an export — response body

Referenced models: Start an export — response body

Schemas

Start an export — response body

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	The unique ID of the export.
links	object	Optional	An object containing relevant links related to the export process. Additional keys: see wildcard field
links.*	string	Additional keys

Start an export — request body — body

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (oneOf 1)	Model	Alternative	Expand Start an export — request body — body / exportType: VIEW, format: CSV, XLS, XLSX
$ (oneOf 2)	Model	Alternative	Expand Start an export — request body — body / exportType: LIST, format: CSV, XLS, XLSX

Referenced models: Start an export — request body — body / exportType: LIST, format: CSV, XLS, XLSX, Start an export — request body — body / exportType: VIEW, format: CSV, XLS, XLSX

Start an export — request body — body / exportType: LIST, format: CSV, XLS, XLSX

Field	Type	Presence	Description and constraints
$	object	Root
associatedObjectType	array	Required within parent	An array of strings specifying the types of associated objects to include in the export.
associatedObjectType[]	string	Each item
exportInternalValuesOptions	array	Required within parent	An array of strings indicating options for exporting internal values. Valid values are 'NAMES' and 'VALUES'.
exportInternalValuesOptions[]	string	Each item	One of: NAMES, VALUES
exportName	string	Required within parent	A string representing the name of the export.
exportType	string	Required within parent	A string indicating the type of export, which is 'LIST' by default. Default: LIST One of: LIST
format	string	Required within parent	A string specifying the format of the export file. Valid values are 'XLS', 'XLSX', and 'CSV'. One of: CSV, XLS, XLSX
includeLabeledAssociations	boolean	Required within parent	A boolean indicating whether to include labeled associations in the export.
includePrimaryDisplayPropertyForAssociatedObjects	boolean	Required within parent	A boolean indicating whether to include the primary display property for associated objects.
language	string	Required within parent	A string specifying the language for the export. Valid values include language codes such as 'EN', 'FR', 'DE', etc. One of: AF_ZA, AR_EG, BG, BN, CA_ES, CS, DA_DK, DE, EL_GR, EN, EN_GB, ES, ES_MX, ET_EE, FI, FR, FR_CA, HE_IL, HI_IN, HR, HU, ID, IT, JA, KO_KR, LT_LT, MS, NL, NO, PL, PT_BR, PT_PT, RO, RU, SK_SK, SL, SV, TH, TL, TR, UK, VI_VN, ZH_CN, ZH_HK, ZH_TW
listId	string	Required within parent	A string representing the ID of the list to be exported.
objectProperties	array	Required within parent	An array of strings listing the properties of the objects to be included in the export.
objectProperties[]	string	Each item
objectType	string	Required within parent	A string representing the type of objects being exported.
overrideAssociatedObjectsPerDefinitionPerRowLimit	boolean	Required within parent	A boolean indicating whether to override the limit on associated objects per definition per row.

Start an export — request body — body / exportType: VIEW, format: CSV, XLS, XLSX

Field	Type	Presence	Description and constraints
$	object	Root
associatedObjectType	array	Required within parent	An array of strings indicating the types of associated objects to include in the export.
associatedObjectType[]	string	Each item
exportInternalValuesOptions	array	Required within parent	An array of strings specifying options for internal values in the export. Valid values are 'NAMES' and 'VALUES'.
exportInternalValuesOptions[]	string	Each item	One of: NAMES, VALUES
exportName	string	Required within parent	The name assigned to the export, represented as a string.
exportType	string	Required within parent	The type of export being requested. The only valid value is 'VIEW'. Default: VIEW One of: VIEW
format	string	Required within parent	The file format for the export. Valid options are 'XLS', 'XLSX', and 'CSV'. One of: CSV, XLS, XLSX
includeLabeledAssociations	boolean	Required within parent	A boolean indicating whether labeled associations should be included in the export.
includePrimaryDisplayPropertyForAssociatedObjects	boolean	Required within parent	A boolean indicating whether the primary display property for associated objects should be included.
language	string	Required within parent	The language code for the export. Valid values include 'EN', 'FR', 'DE', 'JA', 'ES', 'PT_BR', 'NL', 'BN', 'CS', 'DA_DK', 'EL_GR', 'ES_MX', 'FI', 'HR', 'HU', 'ID', 'IT', 'KO_KR', 'NO', 'PL', 'RO', 'RU', 'SV', 'TH', 'VI_VN', 'ZH_CN', 'ZH_HK', 'AF_ZA', 'AR_EG', 'BG', 'CA_ES', 'SL', 'TR', 'UK', 'EN_GB', 'FR_CA', 'HE_IL', 'LT_LT', 'PT_PT', 'SK_SK', 'MS', 'TL', 'ZH_TW', 'HI_IN', 'ET_EE'. One of: AF_ZA, AR_EG, BG, BN, CA_ES, CS, DA_DK, DE, EL_GR, EN, EN_GB, ES, ES_MX, ET_EE, FI, FR, FR_CA, HE_IL, HI_IN, HR, HU, ID, IT, JA, KO_KR, LT_LT, MS, NL, NO, PL, PT_BR, PT_PT, RO, RU, SK_SK, SL, SV, TH, TL, TR, UK, VI_VN, ZH_CN, ZH_HK, ZH_TW
objectProperties	array	Required within parent	An array of strings specifying the properties of the object to be included in the export.
objectProperties[]	string	Each item
objectType	string	Required within parent	A string representing the type of object being exported.
overrideAssociatedObjectsPerDefinitionPerRowLimit	boolean	Required within parent	A boolean indicating whether to override the limit of associated objects per definition per row.
publicCrmSearchRequest	Model	Optional	Expand Start an export — request body — body / exportType: VIEW, format: CSV, XLS, XLSX public Crm Search Request

Referenced models: Start an export — request body — body / exportType: VIEW, format: CSV, XLS, XLSX public Crm Search Request

Start an export — request body — body / exportType: VIEW, format: CSV, XLS, XLSX public Crm Search Request

Field	Type	Presence	Description and constraints
$	object	Root
filterGroups	array	Required within parent	An array of filter groups, where each group contains multiple filters. This allows for complex filtering logic by combining multiple filters together.
filterGroups[]	Model	Each item	Expand Start an export — request body — body / exportType: VIEW, format: CSV, XLS, XLSX public Crm Search Request filter Groups item
filters	array	Required within parent	An array of filter objects used to specify the criteria for the search. Each filter defines a property, an operator, and a value to filter by.
filters[]	Model	Each item	Expand Start an export — request body — body / exportType: VIEW, format: CSV, XLS, XLSX public Crm Search Request filters item
query	string	Optional	The search query string, to filter CRM records.
sorts	array	Required within parent	Defines the order in which the CRM records should be returned.
sorts[]	string	Each item

Referenced models: Start an export — request body — body / exportType: VIEW, format: CSV, XLS, XLSX public Crm Search Request filters item, Start an export — request body — body / exportType: VIEW, format: CSV, XLS, XLSX public Crm Search Request filter Groups item

Start an export — request body — body / exportType: VIEW, format: CSV, XLS, XLSX public Crm Search Request filters item

Field	Type	Presence	Description and constraints
$	object	Root	Defines a single condition for searching CRM objects, specifying the property to filter on, the operator to use (such as equals, greater than, or contains), and the value(s) to compare against.
highValue	string	Optional	A string representing the upper boundary value used with the 'BETWEEN' operator.
operator	string	Required within parent	The operator used to compare the property value against the specified value(s). Valid operators include 'EQ', 'NEQ', 'LT', 'LTE', 'GT', 'GTE', 'BETWEEN', 'IN', 'NOT_IN', 'HAS_PROPERTY', 'NOT_HAS_PROPERTY', 'CONTAINS_TOKEN', and 'NOT_CONTAINS_TOKEN'. One of: BETWEEN, CONTAINS_TOKEN, EQ, GT, GTE, HAS_PROPERTY, IN, LT, LTE, NEQ, NOT_CONTAINS_TOKEN, NOT_HAS_PROPERTY, NOT_IN
propertyName	string	Required within parent	The name of the property to filter by. This is a string value.
value	string	Optional	A string representing the value to compare the property against when using certain operators.
values	array	Optional	An array of string values used with operators like 'IN' and 'NOT_IN' to specify multiple comparison values.
values[]	string	Each item

Start an export — request body — body / exportType: VIEW, format: CSV, XLS, XLSX public Crm Search Request filter Groups item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a group of filters used to query data within HubSpot. This component is used to define criteria for filtering records in various API endpoints.
filters	array	Required within parent	An array of filter objects that define the criteria for the filter group. Each filter specifies a property, an operator, and a value to be used in the filtering process.
filters[]	Model	Each item	Expand Start an export — request body — body / exportType: VIEW, format: CSV, XLS, XLSX public Crm Search Request filters item

Referenced models: Start an export — request body — body / exportType: VIEW, format: CSV, XLS, XLSX public Crm Search Request filters item

Policy, approvals and errors

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