Skip to content
Docs

Get Order

One managed mailbox order with its domains and mailboxes.

GEThttps://api.foxreach.io/api/v1/managed-inboxes/orders/{order_id}

Requires an API key with the read scope.

Path Parameters#

order_idstringpathrequired

The order identifier.

Response#

dataobject

The order.

Show data
idstring
Order identifier.
statusstring
pending_payment, paid, provisioning, active, partially_failed, failed, past_due or cancelled.
redirectUrlstring
Where the domains forward to.
oneTimeCentsinteger
One-time cost in US cents (domain registration).
monthlyCentsinteger
Monthly cost in US cents (mailboxes).
domainCountinteger
Domains in the order.
mailboxCountinteger
Mailboxes in the order.
failureMessagestring
Why the order failed, or null.
createdAtstring
ISO 8601 timestamp.
paidAtstring
ISO 8601 timestamp, or null.
provisionedAtstring
ISO 8601 timestamp, or null.
cancelledAtstring
ISO 8601 timestamp, or null.
domainsarray

Domains in the order.

Show domains
idstring
Domain identifier.
namestring
Domain name.
platformstring
GOOGLE or MICROSOFT.
statusstring
Domain status.
priceCentsinteger
Registration price in US cents.
renewalDatestring
ISO 8601 timestamp, or null.
renewalPriceCentsinteger
Renewal price in US cents, or null.
autoRenewboolean
Whether the domain renews automatically.
renewalStatestring
Renewal state, or null.
failureMessagestring
Why the domain failed, or null.
mailboxesarray
Mailboxes on the domain (same fields as List Mailboxes, without orderId and domainName).

Errors#

StatusDescription
401Missing, invalid, revoked or expired API key
403API key does not have the required scope: read
404Not found while managed mailboxes are switched off on this environment ({"detail": "Not found"})
404Order not found, or the order belongs to another workspace

Rate Limit#

  • 100 requests per minute, per API key. Fixed 60-second window.
  • Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset (unix epoch seconds).
  • A 429 response includes a Retry-After header (seconds until the bucket resets).

For client-side patterns (Retry-After, exponential backoff, monitoring X-RateLimit-Remaining), see Rate Limiting.

Was this page helpful?
View as MarkdownLast updated November 2, 2026