Export the selected organization
Source: OpenAPI (openapi/openapi.yaml).
curl -X GET "https://api.sendtier.example/organizations/string/export" \ -H "Authorization: Bearer st_live_REPLACE_ME"{ "format_version": 1, "exported_at": "2019-08-24T14:15:22Z", "retention_from": "2019-08-24T14:15:22Z", "organization": { "id": "string", "name": "string", "status": "active", "plan": "free", "daily_limit": 0, "monthly_limit": 0, "created_at": "2019-08-24T14:15:22Z", "deletion_requested_at": "2019-08-24T14:15:22Z" }, "members": [ { "id": "string", "email": "string", "role": "owner" } ], "invitations": [ { "id": "string", "email": "user@example.com", "role": "owner", "created_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z" } ], "domains": [ { "id": "string", "name": "string", "status": "pending", "records": [ { "purpose": "dkim", "type": "CNAME", "name": "string", "value": "string", "priority": 0, "status": "pending" } ], "last_checked_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "verified_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z" } ], "api_keys": [ { "id": "string", "name": "string", "mode": "live", "scope": "full", "prefix": "string", "created_at": "2019-08-24T14:15:22Z", "last_used_at": "2019-08-24T14:15:22Z", "revoked_at": "2019-08-24T14:15:22Z" } ], "webhooks": [ { "id": "string", "url": "string", "events": [ "email.queued" ], "test_mode": true, "account_disabled": true, "deleted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z" } ], "suppressions": [ { "email": "string", "reason": "bounce", "created_at": "2019-08-24T14:15:22Z", "source": "api" } ], "emails": [ { "id": "string", "status": "queued", "status_detail": "string", "created_at": "2019-08-24T14:15:22Z", "from": "string", "to": [ "string" ], "subject": "string", "html": "string", "text": "string", "tags": { "property1": "string", "property2": "string" }, "scheduled_at": "2019-08-24T14:15:22Z", "test_mode": true, "domain_id": "string", "provider_message_id": "string", "events": [ { "type": "email.queued", "occurred_at": "2019-08-24T14:15:22Z", "data": {}, "id": "string" } ] } ]}Owner only; the path must match the selected tenant. Streams one JSON document, format version 1, without Content-Length. HTTP/1.1 uses chunked transfer. Includes live and test emails and bodies within the configured UTC-day retention window. Every array is paged. A failed stream is incomplete JSON and must be discarded. One export per tenant per ten minutes; 429 includes Retry-After in seconds. Includes pending invitations without tokens or hashes. Excludes accepted and revoked invitations, global suppressions, authentication subjects, secrets, previous webhook signing secrets, hashes, usage counters, idempotency responses, webhook delivery retries and internal notification bookkeeping. Pages are individually consistent; concurrent changes can appear between pages.
dashboardTokenAuthorizationBearer <token>Dashboard server token: EdDSA Ed25519, issuer is the dashboard origin, audience sendtier-api, iat and exp are required with a maximum lifetime of 15 minutes, sub is the identity subject, email is required. Sendtier-Tenant selects a membership; omission selects the sole membership. Without a selected tenant only GET /me and POST /organizations are available. Sendtier-Mode is live (default) or test; test mode cannot create live keys. Owners, admins and developers have full access. Viewers may only GET or HEAD.
tenant_id*stringStreaming organization export. Cache-Control is no-store.
application/json- response
format_version*11exported_at*stringdate-timeretention_from*stringdate-timeorganization*members*array<>invitations*array<>Pending invitations. Tokens and hashes are omitted.
domains*array<>api_keys*array<>webhooks*array<>suppressions*array<>emails*array<>