The export object

A comprehensive list of the export resource's attributes and relationships

An export object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/exports endpoint.

Fields

FieldTypeDescription

type

string

exports

id

string

The export unique identifier

links.self

string

The export endpoint URL

attributes.resource_type

string

The type of resource being exported.

attributes.format

string

The format of the export one of 'json' (default) or 'csv'.

attributes.status

string

The export job status. One of 'pending' (default), 'in_progress', 'interrupted', or 'completed'.

attributes.includes

array

List of related resources that should be included in the export.

attributes.filters

object

The filters used to select the records to be exported.

attributes.dry_data

boolean

Send this attribute if you want to skip exporting redundant attributes (IDs, timestamps, blanks, etc.), useful when combining export and import to duplicate your dataset.

attributes.started_at

datetime

Time at which the export was started.

attributes.completed_at

datetime

Time at which the export was completed.

attributes.interrupted_at

datetime

Time at which the export was interrupted.

attributes.records_count

integer

Indicates the number of records to be exported.

attributes.attachment_url

string

The URL to the output file, which will be generated upon export completion.

attributes.created_at

datetime

Time at which the resource was created.

attributes.updated_at

datetime

Time at which the resource was last updated.

attributes.reference

string

A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.

attributes.reference_origin

string

Any identifier of the third party system that defines the reference code.

attributes.metadata

object

Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.

relationships.events

array

The associated events.

meta.mode

string

The resource environment (can be one of test or live)

Last updated