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
exportInternalValuesOptions
enum<string>[]
required
Available options:
NAMES,
VALUES
exportName
string
required
exportType
enum<string>
default:VIEW
required
Available options:
VIEW
format
enum<string>
required
Available options:
CSV,
XLS,
XLSX
includeLabeledAssociations
boolean
required
includePrimaryDisplayPropertyForAssociatedObjects
boolean
required
language
enum<string>
required
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
objectType
string
required
overrideAssociatedObjectsPerDefinitionPerRowLimit
boolean
required
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 March 31, 2026