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

JavaScript SDK: swarmhit.mailboxOrders.list(params?)

The workspace's orders, newest first, each with its domains and mailboxes and the step each mailbox is at. By default the list is the acting workspace's own, as it always was. Optional, for an organization's key acting as the organization (no X-Swarmhit-Workspace): orgWide=true adds the orders of every workspace inside it, and workspaceId picks one of them. With either one, each order also carries workspaceId and workspaceName.

Authorization

bearerAuth
AuthorizationBearer <token>

An API key created on the Access tokens page.

In: header

Query Parameters

status?string

paid → placing → placed → provisioning (domains and mailboxes being created) → authorizing (granting our access) → connecting → completed. needs_attention = delayed, our team is on it (it can resume); cancelled = stopped and refunded.

Value in

  • "quoted"
  • "paid"
  • "placing"
  • "placing_unknown"
  • "placed"
  • "provisioning"
  • "authorizing"
  • "connecting"
  • "completed"
  • "needs_attention"
  • "cancelled"
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
workspaceId?string

Optional: only this workspace, and each row names its workspaceId and workspaceName. With an organization's key acting as the organization, any workspace of the organization (or the organization itself); otherwise only the acting workspace. Any other id is a 404 (code: not-found), so a workspace never learns whether another one exists.

limit?integer

Page size, 1–100.

Range1 <= value <= 100
Default50
offset?integer

Number of records to skip.

Range0 <= value
Default0

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/mailbox-orders"
{  "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"    }  ],  "paging": {    "limit": 0,    "offset": 0  }}

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.

List the domains you bought GET

**JavaScript SDK:** [`swarmhit.managedDomains.list(params?)`](/smart-api/sdk/methods#managedDomains) The workspace's bought domains and how many more mailboxes each can take (5 per domain on Google Workspace and Microsoft 365). Add mailboxes to one with a domain entry `{ name, existing: true, mailboxes }` in POST /mailbox-orders/quote (with `X-Swarmhit-Workspace` naming the domain's workspace when it is not the key's own). `canAdd: false` says why in `reason`. Not gated on the managed mailboxes feature. By default the list is the acting workspace's own, as it always was. Optional, for an organization's key acting as the organization (no `X-Swarmhit-Workspace`): `orgWide=true` adds the domains of every workspace inside it, and `workspaceId` picks one of them. With either one, each domain also carries `workspaceId` and `workspaceName`.