Skip to content
WorkRoad home
REST API

Get the account export

GET
/export

The latest account export: everything the user's account holds in one ZIP (notes as Markdown with their images and files, recordings, study sets with their review history, tasks, schedules, tests, Copilot chats and settings as JSON). Start one with POST /export. data is null when none was started in the last 7 days.

Required scopes: account:export

Authorization

headerAuthorizationBearer <token>

Response Body

OK

application/json
  1. response
data*|null
Example Request
curl -X GET 'https://workroad.app/api/v1/export' \  -H 'Authorization: Bearer $WORKROAD_API_KEY'
Example Response
{  "data": {    "id": "4f1c2b3a-5d6e-4f70-8a9b-0c1d2e3f4a5b",    "status": "ready",    "createdAt": "2026-10-28T09:15:00.000Z",    "downloadUrl": "https://storage.example.com/export/…/4f1c2b3a.zip?X-Amz-Signature=…",    "expiresAt": "2026-11-04T09:21:42.000Z",    "sizeBytes": 48213504  }}

Search the docs GET

Searches the WorkRoad docs: the guides to each part of the app, the REST API guide, the MCP server guide and the reference page of every operation.

Start an account export POST

Starts building the account export, or returns the one already being built.