Get sandbox usage

GET/api/v1/sandbox/usage
Requires anorganization API keywith the scopesandbox:read

Where your organization stands against the sandbox limits: inboxes used, messages accepted this month, and the per-inbox and per-message limits. The sandbox is free on every plan and never uses sending credits.

Request

GET/api/v1/sandbox/usage
curl -X GET 'https://app.mailyte.com/api/v1/sandbox/usage' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY'
The key names its own organization, so no X-Organization-ID header is needed.

Response

Success.

  • dataobject
    • inboxesinteger

      Inboxes the organization has now.

    • inbox_limitinteger
    • monthstring

      The calendar month counted, `YYYY-MM` (UTC).

    • month_acceptedinteger

      Messages accepted this month, across every inbox.

    • monthly_limitinteger

      Past it, new messages are refused until the month turns.

    • max_message_bytesinteger
    • max_messagesinteger

      The most any one inbox keeps.

    • retention_daysinteger

      The longest any message is kept.

Returned inside the standard envelope.

Errors

StatusWhen
401The API key is missing, unknown, revoked or expired. All four answer identically, on purpose: distinguishing them would confirm which keys exist.
403The key is valid but may not do this: it lacks the required scope, its IP allowlist does not include you, or this endpoint does not accept API keys.
404No such resource in this organization.
422The request was understood but the values were not acceptable.
429Too many requests, or the organization has spent its sending allowance. `Retry-After` says how long to wait.

Every status, with what causes it and what to do, is on the error reference.