HubSpot: Exports schemas

← Exports operations · All 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

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

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

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 — 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