Org / AWS / SES / plan snapshot

Search Documentation

Search across all developer documentation

account

Org / AWS / SES / plan snapshot

GET /v1/account
Auth required org.view

Returns a composed snapshot of the calling org's onboarding state: organization metadata, the connected AWS account and live SES send quota, the production-access request status, the CloudFormation template version, and the active plan. The response is cached per-org for 60 seconds (a Cache-Control: max-age=60 response header advertises this), so repeated polling does not generate extra AWS or DB load.

Each top-level field is always present — sub-objects are null when the corresponding milestone has not been reached:

  • aws and send_quota are null until the customer has connected an AWS account, and also null if the live SES GetAccount call fails (the rest of the response still renders — SES failure degrades gracefully, it does not 5xx).
  • production_access is null until the customer has submitted a production-access request.
  • cloudformation is null until the customer has applied the SendOps CloudFormation stack.

aws.sandbox is the live SES sandbox flag (true while SES still has the AWS account in the default sandbox); this is distinct from production_access.status, which reflects the SendOps-side request workflow. Use this endpoint to drive onboarding UIs, detect template drift, and gate features on plan tier.

Responses

200 Composed account snapshot application/json
401 Missing, malformed, or unknown API key application/problem+json
403 Key lacks the required scope or plan limit violated application/problem+json
429 Per-org rate limit exceeded application/problem+json
500 Unexpected server-side failure. The code is internal_error. The request_id field can be quoted to SendOps support to investigate. application/problem+json