POST/organizations/{organizationId}/exports

Create an export

Creates an asynchronous CSV or JSONL export from a saved dataset and filter snapshot.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokenBearerAuthoptional

Stored only in this browser for the BearerAuth security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

organizationIdpath · stringrequired

Opaque organization identifier.

Idempotency-Keyheader · string · uuidoptional

Unique key for retry-safe writes, retained for 24 hours.

Request body

application/jsonrequired

resourceenumrequired

Values: "contacts" · "events" · "audit_logs" · "invoices"

formatenumrequired

Values: "csv" · "jsonl"

filtersobjectoptional

columnsarray<string>optional

deliveryobjectoptional

encryptionobjectoptional

Responses

202application/json

Export accepted.

{
  "id": "exp_01J8FN7Q2P4T9V6K3M5",
  "resource": "contacts",
  "format": "csv",
  "status": "completed",
  "row_count": 18942,
  "file": {
    "id": "fil_01J8FE2X7M5P9Q4V6K1",
    "download_url": "https://downloads.demo.heyo.example/signed/fil_01J8FE2X7M5P9Q4V6K1"
  },
  "delivery": {
    "type": "signed_download",
    "expires_at": "2026-09-06T12:00:00Z"
  },
  "created_at": "2026-09-03T11:20:00Z",
  "completed_at": "2026-09-03T11:22:14Z"
}

idstringoptional

resourcestringoptional

formatstringoptional

statusstringoptional

row_countobjectoptional

fileobjectoptional

deliveryobjectoptional

created_atstring · date-timeoptional

completed_atobject · date-timeoptional

422

Selected columns or delivery settings are invalid.

curl --request POST \ 'https://api.demo.heyo.example/v3/organizations/org_01J8F1Q6N6VTX4E8W9R2D0A7B3/exports' \ --header 'Idempotency-Key: 5ba89923-8c6d-44a3-9ab7-2fbbdb865f9a' \ --header 'Content-Type: application/json' \ --data '{ "resource": "contacts", "format": "csv", "filters": { "lifecycle": [ "active" ], "tag": "customer" }, "columns": [ "id", "email", "company", "lifecycle", "created_at" ], "delivery": { "type": "signed_download", "expires_in_hours": 72 }, "encryption": { "type": "none" }}'

{ "id": "exp_01J8FN7Q2P4T9V6K3M5", "resource": "contacts", "format": "csv", "status": "completed", "row_count": 18942, "file": { "id": "fil_01J8FE2X7M5P9Q4V6K1", "download_url": "https://downloads.demo.heyo.example/signed/fil_01J8FE2X7M5P9Q4V6K1" }, "delivery": { "type": "signed_download", "expires_at": "2026-09-06T12:00:00Z" }, "created_at": "2026-09-03T11:20:00Z", "completed_at": "2026-09-03T11:22:14Z" }