Export the organization's data
The organizations.export operation: POST /api/v1/organizations/{id}/exports in the REST API and the organizations_export tool in the MCP server.
/api/v1/organizations/{id}/exportsRequests an export of everything in the organization: one JSON file per kind of record (legal entities, brands, customers, subscriptions, invoices, the ledger, registrations, filings and the rest, both modes), plus the PDFs of its invoices and credit notes, in one ZIP archive. Secrets, hashes and tokens are left out.
It's built in the background (poll organizations.exports.list until status is ready) and can be
downloaded from the console for 7 days. One export is built at a time. Closed organizations can still export.
Needs org:admin (organization owners and admins). Security tier for agents: it holds all of the
organization's data.
At a glance
- REST:
POST /api/v1/organizations/{id}/exports - MCP tool:
organizations_export - Operation ID:
organizations.export - Scope: Organization
- Permission:
org:admin - Risk tier:
security - Dry run: Supported (send
Ownrecord-Dry-Run: true) - Idempotency:
Idempotency-Keyrequired - Modes: Test and live
- Authentication: API key with the
org:adminscope - Since: M12
Request
Path parameters
| Field | Type | Description |
|---|---|---|
id | org_… ID |
Body
This operation takes no body.
Response
201 Created with a JSON object:
| Field | Type | Description |
|---|---|---|
id | exp_… ID | |
object | "organization_export" | |
status | one of queued, running, ready, expired, failed | queued, running, then ready (downloadable for 7 days, then expired) or failed. |
requestedBy | object | |
requestedBy.type | string | |
requestedBy.id | string | |
file | object or null | |
failure | object or null | |
readyAt | date-time or null | |
expiresAt | date-time or null | |
createdAt | date-time | |
updatedAt | date-time |
Examples
Request an export
POST /api/v1/organizations/org_01m4tx5nj7ekd958x53w4bntcg/exports
Authorization: Bearer or_test_…
Idempotency-Key: 3f1c9a52-7d0e-4b8f-9a61-0c2d5e8b7f14
Response (201):
{
"id": "exp_01m4tx5nj8emwbyf7y9vcf47xf",
"object": "organization_export",
"status": "queued",
"requestedBy": {
"type": "user",
"id": "usr_01m4tx5nj8emwbyf7y9vcf47xa"
},
"file": null,
"failure": null,
"readyAt": null,
"expiresAt": null,
"createdAt": "2026-10-26T09:00:00.000Z",
"updatedAt": "2026-10-26T09:00:00.000Z"
}
Errors
| Code | HTTP status | When | What to do |
|---|---|---|---|
organization_export_in_progress | 409 | An export is already queued or being built. | Wait for it to be ready (organizations.exports.list), then download it. |
resource_not_found | 404 | The ID isn't the organization of the request. | Check the ID and that your credentials are scoped to the right organization, entity, brand and mode. |
permission_denied | 403 | You can't export this organization. | Ask an organization owner or admin for a role or scope that allows this action. |
It can also return these common errors: validation_failed, api_version_unsupported, invalid_json, unsupported_media_type, authentication_required, api_key_invalid, idempotency_key_required, idempotency_key_reused, idempotency_in_progress, approval_required, approval_rejected, approval_expired, stale_approval, approval_policy_denied, rate_limited, internal_error.