v1

latestOpenAPI 3.1.02026-08-04751,1671.3 MB
Exports

Get Export

Get an export by ID

get/api/v1/exports/{id}

Path parameters

idstring uuid required

ID of the export to retrieve.

ID of the export to retrieve.

Response

Successful Response

idstring uuid required

ID of the export.

creation_timestring date-time required

The date and time when the object was created.

type'csv' | 'zip' required
state'created' | 'in_progress' | 'aborted' | 'ready' | 'error' required
organization_idstring uuid required

The id of the organization.

user_idstring required

The id of the user.

resource_type'transaction' | 'backup_snapshot' | 'vault' required
successful_items_countinteger required

The number of items that were successfully exported.

failed_items_countinteger required

The number of items that failed to be exported.

total_items_countinteger required

The total number of items to be exported.

request_idstring required

The request id of the export.

download_urlstring required

The download url of the export.

expiration_timestring date-time required

The date and time when the object will expire.