Create an export
/exportsRequests a data export. The file is generated asynchronously by an export.generate operation, whose ID is returned in operation_id; use the retrieve operation to follow the export status.
Each entry in columns must belong to the column catalog of the selected resource, and filters accepts the same keys as the users collection: product_id, tag_id, showcase_id, delivery_id, access, type, and status. Unknown columns or filters are rejected with a validation error.
Requesting personal data columns (email, document, or phone) also requires the users.read_personal permission. Without it, the request is rejected with permission_denied instead of silently omitting those columns.
The generated file is a UTF-8 CSV and is retained for 7 days.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/exports" \ -H "Content-Type: application/json" \ -d '{ "columns": [ "string" ], "resource": "users" }'{ "data": { "columns": [ "string" ], "consistency": { "snapshot_at": "2019-08-24T14:15:22Z" }, "created_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z", "failure_reason": "string", "file_id": "string", "filters": { "access": "string", "delivery_id": "string", "product_id": [ "string" ], "showcase_id": "string", "status": "string", "tag_id": [ "string" ], "type": "string" }, "id": "string", "object": "export", "operation_id": "string", "resource": "users", "status": "queued", "total": 0 }}List exports GET
Lists the exports of the current account using cursor-based pagination. The collection can be filtered by `resource`. Exports never include a download URL. To download a file, request a short-lived download link for its `file_id` from the files API.
Retrieve an export GET
Retrieves an export by its public ID. When generation finishes, `status` becomes `completed` and the response includes `file_id`, `total`, and `expires_at`. If generation fails, `status` becomes `failed` and `failure_reason` describes the cause. Generated files are retained for 7 days. After that, `status` becomes `expired` and `file_id` is `null`. The export never includes a download URL. To download the file, request a download link for `file_id` from the files API.