Skip to content
WorkRoad home
REST API

Start an account export

POST
/export

Starts building the account export, or returns the one already being built. It takes a few minutes for a large account; poll GET /export until status is ready. The user also gets an email with a link when it is ready.

Required scopes: account:export

Authorization

headerAuthorizationBearer <token>

Header Parameters

Idempotency-Key?string

A client-generated key (1 to 255 visible ASCII characters) that makes this POST safe to retry. A retry with the same key and body replays the original response; the same key with a different body returns 409 idempotency_conflict. Stored for 24 hours.

Match^[\x21-\x7E]{1,255}$
Length1 <= length <= 255

Response Body

Accepted

application/json
  1. response
data*
Example Request
curl -X POST 'https://workroad.app/api/v1/export' \  -H 'Authorization: Bearer $WORKROAD_API_KEY'
Example Response
{  "data": {    "id": "4f1c2b3a-5d6e-4f70-8a9b-0c1d2e3f4a5b",    "status": "pending",    "createdAt": "2026-10-28T09:15:00.000Z",    "downloadUrl": null,    "expiresAt": null,    "sizeBytes": null  }}