Exports
An export packages the documents of a case in the format you choose.
Exports run in the background: create one, then check its status or wait
for the export.completed or export.failed webhook event.
Paths are relative to /api/v1.
POST/exports
Scope: exports:write · Idempotency-Key required
Request an export. Returns 202 Accepted with the export in pending status.
| Field | Type | Required | Description |
|---|---|---|---|
case_id | string | Yes | The case to export. |
format | string | No | pdf (default), csv, json, or zip. |
filters | object | No | Filters that narrow the export. Defaults to no filters. |
curl -X POST https://{api-host}/api/v1/exports \
-H "x-api-key: rdx_live_..." \
-H "Idempotency-Key: 6f1c2a1e-9d2b-4c7a-8e51-3b0f7a2d9c10" \
-H "Content-Type: application/json" \
-d '{ "case_id": "case_123", "format": "zip" }'GET/exports
Scope: exports:read · Paginated
List exports in your organization, newest first. Query: limit, cursor.
GET/exports/{export_id}
Scope: exports:read
Read an export and its status. Status values are pending,
processing, completed, failed, and
cancelled.
GET/exports/{export_id}/download-url
Scope: exports:read
Return a URL for the finished file. The URL is available only after the
export reaches completed; before that, the request is rejected.
POST/exports/{export_id}/cancel
Scope: exports:write · Idempotency-Key required
Cancel an export that is pending or processing.
Exports in any other status cannot be cancelled.
POST/exports/{export_id}/retry
Scope: exports:write · Idempotency-Key required
Retry an export whose status is failed. Other statuses cannot be retried.