Exports List
Exports of the organization, newest first. Reserved to administrators: an export is a bulk extract of personal data and its history is the record of who took it.
Query Parameters
Possible values: >= 1
Default value: 100
- 200
OK
Schema
- Array [
- Array [
- ]
- ]
items object[]
Unique identifier of the export.
An enumeration.
An enumeration.
An enumeration.
Human-readable name of the export, built from its kind and the moment it ran.
Name of the generated file. Null until it is ready.
Records written to the file.
Size of the file in bytes.
When the file is deleted. The export itself is kept as history.
How many times the file has been downloaded.
When the file was last downloaded.
How many times the generation was attempted, retries included.
Identifier of the background task generating the file.
The filters the export ran with, copied when it was requested. Empty when it ran over everything.
Whether the export ran over an explicit selection of records rather than filters.
Name of the staff member who requested the export. Null when it was not started by a person.
Name of the saved segment the export ran over. Null when it ran over ad-hoc filters.
fields object[] required
The columns the export was asked to produce, in the order they appear in the file.
Identifier of the column, as written in the file header.
Human-readable name of the column. Falls back to the key when the column no longer exists.
An enumeration.
Details of the failure. Null when it did not fail.
Post-processing script the export ran with. Null when it had none.
Address the file is served from with an Authorization: Bearer header. Null when the file is not ready or no longer available. Only administrators of the organization can download it.
When the export was requested.
When the export was last modified.
{
"items": [
{
"id": 0,
"kind": "SUPPORTERS",
"format": "XLSX",
"state": "PENDING",
"label": "string",
"filename": "string",
"rows_total": 0,
"file_size": 0,
"expires_date": "2026-11-20T20:19:36.565Z",
"download_count": 0,
"last_download_date": "2026-11-20T20:19:36.565Z",
"attempts": 0,
"task_id": "string",
"filters": {},
"from_selection": true,
"staff_name": "string",
"segment_name": "string",
"fields": [
{
"key": "string",
"label": "string"
}
],
"error_code": "FIELDS_INVALID",
"error_message": "string",
"script": "string",
"download_url": "string",
"create_date": "2026-11-20T20:19:36.565Z",
"update_date": "2026-11-20T20:19:36.565Z"
}
],
"count": 0
}