Developers
Open Swarmhit
Smart APIRaw API
API referenceMailbox orders
GET
/mailbox-orders/{id}

JavaScript SDK: swarmhit.mailboxOrders.get(mailboxOrderId, params?)

One order with every domain and mailbox and its step. By default only an order of the acting workspace, as it always was. With orgWide=true, an organization's key acting as the organization also finds the orders of the workspaces inside it, and the order carries workspaceId and workspaceName.

Authorization

bearerAuth
AuthorizationBearer <token>

An API key created on the Access tokens page.

In: header

Path Parameters

id*string

Query Parameters

orgWide?boolean

Optional, off by default. With an organization's key acting as the organization, also every workspace inside it, each row naming its workspaceId and workspaceName. Any other key keeps the acting workspace only. Without it, the answer is exactly what it always was.

Defaultfalse

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/mailbox-orders/string"
{  "data": {    "id": "string",    "workspaceId": "string",    "workspaceName": "string",    "status": "quoted",    "delayed": true,    "statusLabel": "string",    "createdVia": "app",    "hostedLinkId": "string",    "warmup": {      "enabled": true,      "strategy": {        "preset": "conservative",        "startingVolume": 1,        "dailyIncrease": 1,        "targetVolume": 1,        "replyInbox": [          0,          0        ],        "replyPromotions": [          0,          0        ],        "replySpam": 0      }    },    "domains": [      {        "name": "string",        "existing": true,        "platform": "google",        "years": 0,        "redirectUrl": "string",        "status": "pending",        "refusedReason": "string",        "emailVerification": {          "status": "pending",          "deadline": "2019-08-24T14:15:22Z"        },        "mailboxes": [          {            "email": "string",            "firstName": "string",            "lastName": "string",            "step": "ordered",            "accountId": "string",            "connectedAt": "2019-08-24T14:15:22Z"          }        ]      }    ],    "totals": {      "totalCents": 0,      "currency": "string"    },    "completedAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}

What you pay for bought mailboxes GET

**JavaScript SDK:** [`swarmhit.mailboxBilling.get()`](/smart-api/sdk/methods#mailboxBilling) Bought mailboxes and domains are billed apart from the plan, each purchase on its own date and monthly from then on. This returns the monthly total and next charge date, the card charged, each purchase (mailboxes, price, status, a `payUrl` when a payment failed, the last receipt) and each domain's renewal (date, price or an estimate, status, `payUrl` when declined). Same data as the **Mailboxes & domains** tab of Settings → Billing in Swarmhit. `403` with `code: not-allowed` unless the key's creator may manage billing. Not gated on the managed mailboxes feature.

Get one domain GET

**JavaScript SDK:** [`swarmhit.managedDomains.get(managedDomainId, params?)`](/smart-api/sdk/methods#managedDomains) One of the workspace's domains, bought or own: its room for mailboxes, and for an own domain where its connection stands. With `orgWide=true`, an organization's key also finds its workspaces' domains, each naming its workspace; acting on one (check, delete) takes `X-Swarmhit-Workspace` naming that workspace.