Retrieve an export (signed download)
GET /v1/exports/{export}: Retrieve an export (signed download).
GET /v1/exports/{export}
The export’s state and, once ready and until it expires (24 hours after completion), download_url. The URL is signed for each request and valid for at most 15 minutes (expires_at is the URL’s expiry); retrieve the export again for a fresh one. bundles lists the export’s files (one, or one per organization when an environment export exceeds the bundle limits), each signed the same way. Another environment’s export is not found.
- Scope
exports:write- Auth
- Secret key (
sk_…) - Since
- 1.0
Path parameters
Section titled “Path parameters”exportstring Required
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Responses
Section titled “Responses”- 200 OK Export
- 400 Invalid request. Codes: parameter_invalid, parameter_missing, version_unsupported and resource-specific codes from the catalogue. Error
- 401 Codes: authentication_required, api_key_invalid. Error
- 403 Codes: api_key_scope_missing, ip_not_allowed, plan_limit_reached. Error
- 404 Code: resource_not_found (also returned for other tenants’ IDs); a path no endpoint serves answers route_not_found. A browser GET or HEAD of an unknown path whose Accept ranks text/html above JSON gets an HTML 404 page instead, with the same status; every other client gets this JSON body. Error
- 429 Code: rate_limited. Retry-After is set. Error
- 503 Code: service_unavailable. Retry-After is set; writes are paused. Error
- default Any other error, including internal_error. Every code is in the error catalogue. Error
Errors share one shape; see the error code catalogue.
curl -X GET \ "https://api.ohauthcat.com/v1/exports/exp_01J9Z3K5V7W8X9Y0Z1A2B3C4D5" \ -H "Authorization: Bearer $OHAUTHCAT_API_KEY"const response = await fetch("https://api.ohauthcat.com/v1/exports/exp_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", { method: "GET", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, },});const data = await response.json();import osimport requests
response = requests.get( "https://api.ohauthcat.com/v1/exports/exp_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"},)data = response.json(){ "id": "exp_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "object": "export", "organization": "example_organization", "secrets_to_reenter": [ { "kind": "oidc_client_secret", "id": "01J9Z3K5V7W8X9Y0Z1A2B3C4D5" } ], "failure_reason": "example_failure_reason", "created_at": "2026-01-15T09:30:00Z", "state": "pending", "download_url": "https://app.acme.com/callback", "expires_at": "2026-01-15T09:30:00Z", "bundles": [ { "organization": "example_organization", "state": "ready", "size": 1, "download_url": "https://app.acme.com/callback", "expires_at": "2026-01-15T09:30:00Z", "failure_reason": "example_failure_reason" } ]}