API ReferenceEndpointsTransfers
Import an uploaded bundle (admin only)
The request body is the bundle file exactly as downloaded. It is written to disk as it arrives and checked by the import job, which refuses a bundle whose checksums do not match before storing anything.
Authorization
bearerAuth AuthorizationBearer <token>
Session token issued by the accounts service (or the legacy /v1/auth routes).
In: header
Query Parameters
project_uuid?string
An empty project of this organization to import into; omitted creates a project
Format
uuidproject_name?string
Name of the created project; defaults to the bundle's
data_residency?string
Value in
- "US"
- "EU"
allow_non_empty?boolean
Default
falseRequest Body
application/octet-stream
TypeScript Definitions
Use the request body type in TypeScript.
body*file
Format
binaryResponse Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/imports/upload" \ -H "Content-Type: application/octet-stream" \ -d '<bundle bytes>'{ "notice": "store the project secret now; it is not shown again", "project": { "created_at": "2026-09-13T12:30:45Z", "data_residency": "US", "key": "3142566d8c88721d6d34bd9443d556bf", "name": "Mobile app", "organization_uuid": "0b7e2b1a-0a1b-4c2d-8e3f-4a5b6c7d8e9f", "secret": "ps_9c0f…", "selected": true, "status_uuid": "9d3f1e2c-5a6b-4c7d-8e9f-0a1b2c3d4e5f", "updated_at": "2026-09-13T12:30:45Z", "uuid": "5f1c2e7a-1c2d-4b3e-9f10-1a2b3c4d5e6f" }, "project_created": true, "transfer": { "bundle_bytes": 0, "bundle_deleted": false, "created_at": "2026-09-13T12:30:45Z", "created_by": "c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f", "kind": "import", "options": { "include_events": true }, "organization_uuid": "0b7e2b1a-0a1b-4c2d-8e3f-4a5b6c7d8e9f", "progress": { "boards": 3, "cohorts": 2, "event_part_rows": 0, "event_parts_done": 0, "events_done": 450000, "events_total": 1200000, "phase": "events", "users_done": 8000, "users_total": 8000 }, "project_uuid": "5f1c2e7a-1c2d-4b3e-9f10-1a2b3c4d5e6f", "started_at": "2026-09-13T12:30:45Z", "status": "queued", "updated_at": "2026-09-13T12:30:45Z", "uuid": "7a9b0c1d-2e3f-4a5b-8c6d-7e8f9a0b1c2d" }}