Skip to the documentation
API

Retrieve an export

One export, with its status and progress.

GET/exports/{id}

Runs the real call on your workspace.

GET /exports/{id}

One export, with its status and progress.

Example

Needs threads:read. status is queued, running, ready, failed or expired, and while it is running phase and threadsDone say how far it got.

curl
curl "$OE/exports/exp_8c1e4a7f2b9d3e6a0c5f1b28" -H "$AUTH"
Response
{  "object": "export",  "id": "exp_8c1e4a7f2b9d3e6a0c5f1b28",  "status": "ready",  "phase": null,  "createdAt": "2026-09-30T09:12:44.000Z",  "createdBy": { "name": "Ana Lima", "email": "[email protected]" },  "startedAt": "2026-09-30T09:12:46.000Z",  "finishedAt": "2026-09-30T09:31:02.000Z",  "expiresAt": "2027-09-30T09:31:02.000Z",  "sizeBytes": 1840233472,  "fileName": "acme_20260930_093102.zip",  "threadsDone": 18420,  "threadsTotal": 18420,  "error": null}

An unknown id is a 404.

Reference