Skip to main content
POST
Start an export

Supported products

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
associatedObjectType
string[]
required

An array of strings indicating the types of associated objects to include in the export.

exportInternalValuesOptions
enum<string>[]
required

An array of strings specifying options for internal values in the export. Valid values are 'NAMES' and 'VALUES'.

Available options:
NAMES,
VALUES
exportName
string
required

The name assigned to the export, represented as a string.

exportType
enum<string>
default:VIEW
required

The type of export being requested. The only valid value is 'VIEW'.

Available options:
VIEW
format
enum<string>
required

The file format for the export. Valid options are 'XLS', 'XLSX', and 'CSV'.

Available options:
CSV,
XLS,
XLSX
includeLabeledAssociations
boolean
required

A boolean indicating whether labeled associations should be included in the export.

includePrimaryDisplayPropertyForAssociatedObjects
boolean
required

A boolean indicating whether the primary display property for associated objects should be included.

language
enum<string>
required

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

Available options:
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
string[]
required

An array of strings specifying the properties of the object to be included in the export.

objectType
string
required

A string representing the type of object being exported.

overrideAssociatedObjectsPerDefinitionPerRowLimit
boolean
required

A boolean indicating whether to override the limit of associated objects per definition per row.

publicCrmSearchRequest
object

Response

accepted

id
string
required

The unique ID of the export.

An object containing relevant links related to the export process.

Last modified on September 9, 2026