Skip to content
Dashboard
Theme
Theme

Export the organization list as CSV

POST /v1/organization_exports: Export the organization list as CSV.

View Markdown

POST /v1/organization_exports

Starts a server-side CSV export of the environment’s organizations (id, name, external_id, status, created_at, metadata as JSON), newest first, optionally narrowed by the list’s exact metadata filter. Poll GET /v1/organization_exports/{export} for the download URL, valid 24 hours. Cells a spreadsheet would run as a formula are prefixed with a quote.

Scope
organizations:read
Auth
Secret key (sk_…)
Since
1.0
  • OhAuthCat-Version string

    Minor version; defaults to the environment’s pin.

  • metadata object

    Exact metadata filter, like metadata[key]=value on the list.

Errors share one shape; see the error code catalogue.

curl -X POST \
"https://api.ohauthcat.com/v1/organization_exports" \
-H "Authorization: Bearer $OHAUTHCAT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"metadata": {
"plan": "enterprise"
}
}'
Response 202
{
"id": "oexp_01J9ZQ4M7K2X8V3N5B6C1D0E9F",
"object": "organization_export",
"state": "pending",
"row_count": 1,
"url": "https://app.acme.com/callback",
"expires_at": "2026-01-15T09:30:00Z"
}