Skip to content
IForevents Docs
IForevents Docs
HomeDashboardGitHubPrivacyTermsSecurityIntroduction
Support and SLA

Export a project to a bundle, in the background (admin only)

POST
/v1/projects/{project_uuid}/exports

Queues an export job and answers at once. The job writes the project, its cohorts and boards and (unless include_events is false) its profiles and events to a bundle file, reading in bounded chunks under a rows-per-second budget so the api stays responsive. Poll GET /v1/transfers/{transfer_uuid}; download the bundle when it succeeds. Bundles expire after TRANSFER_BUNDLE_TTL_HOURS (72 by default).

Authorization

bearerAuth
AuthorizationBearer <token>

Session token issued by the accounts service (or the legacy /v1/auth routes).

In: header

Path Parameters

project_uuid*string
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/exports" \  -H "Content-Type: application/json" \  -d '{    "include_events": true  }'
{  "transfer": {    "bundle_bytes": 0,    "bundle_deleted": false,    "created_at": "2026-09-13T12:30:45Z",    "created_by": "c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f",    "kind": "export",    "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": "running",    "updated_at": "2026-09-13T12:30:45Z",    "uuid": "7a9b0c1d-2e3f-4a5b-8c6d-7e8f9a0b1c2d"  }}
from?string
Formatdate-time
include_events?boolean
to?string
Formatdate-time