The workspace's orders, newest first, each with its domains and mailboxes and the step each mailbox is at.
Authorization
bearerAuth An API key created under Settings → API & Webhooks.
In: header
Query Parameters
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"
Page size, 1–100.
1 <= value <= 10050Number of records to skip.
0 <= value0Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/mailbox-orders"{ "data": [ { "id": "string", "status": "quoted", "delayed": true, "statusLabel": "string", "createdVia": "app", "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", "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 a mailbox order GET
Previous Page
List the domains you bought GET
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. `canAdd: false` says why in `reason`. Not gated on the managed mailboxes feature.