Starts an IDP export.

POST {{baseUrl}}/imported-data-projects/:idpSourceId/exports

Starts an export of an IDP's records.

This page will provide additional details and things you should know about this endpoint.

Max File Size

Currently, exports exceeding 1.8 GB will fail. To prevent your export from failing, use proper limits and filters to limit the size of your final export file.

Request Body

{"format"=>"csv", "compress"=>true, "formatDecimalAsComma"=>false, "limit"=>"<integer>", "newlineReplacement"=>"<string>", "timeZone"=>"UTC", "useLabels"=>false, "startDate"=>"1970-01-01T01:00:00Z", "endDate"=>"2100-01-01T01:00:00Z", "continuationToken"=>"<string>", "allowContinuation"=>"false", "sortByLastModifiedDate"=>"false", "fields"=>["<string>", "<string>"]}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;result&quot;:{&quot;jobId&quot;:&quot;\u003cstring\u003e&quot;},&quot;meta&quot;:{&quot;httpStatus&quot;:&quot;\u003cstring\u003e&quot;,&quot;requestId&quot;:&quot;\u003cstring\u003e&quot;,&quot;notice&quot;:&quot;\u003cstring\u003e&quot;}}