Connected mailboxes, newest first, with their status, pause state (paused / pausedReason), daily limit and usage, and the gateway counters (counters.sent, bounced, complained). Credentials are never returned. A Google or Microsoft mailbox connects over the API through a hosted link (POST /email-accounts/hosted-link); mailboxes on a password are connected from the app.
Authorization
bearerAuth An API key created under Settings → API & Webhooks.
In: header
Query Parameters
Page size, 1–100.
1 <= value <= 10050Number of records to skip.
0 <= value0Response Body
application/json
application/json
curl -X GET "https://example.com/email-accounts"{ "data": [ { "id": "string", "label": "string", "email": "string", "fromName": "string", "provider": "google", "authType": "password", "connectedVia": "app", "hostedLinkId": "string", "status": "pending", "error": "string", "limits": {}, "usage": {}, "paused": true, "pausedReason": "user", "pausedAt": "2019-08-24T14:15:22Z", "trackOpens": true, "trackClicks": true, "dnsHealth": { "domain": "string", "managed": true, "spf": { "status": "ok", "reason": "string" }, "dkim": { "status": "ok", "reason": "string", "selector": "string" }, "dmarc": { "status": "ok", "reason": "string", "policy": "none" }, "checkedAt": "2019-08-24T14:15:22Z" }, "deliverabilityTest": { "status": "running", "startedAt": "2019-08-24T14:15:22Z", "finishedAt": "2019-08-24T14:15:22Z", "landing": "inbox", "spf": "string", "dkim": { "result": "string", "selector": "string" }, "dmarc": "string", "blocklists": { "ip": "clean", "domain": "clean" }, "failure": "send" }, "counters": {}, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "managed": { "provider": "string", "domain": "string", "status": "string", "renewsAt": "2019-08-24T14:15:22Z", "cancelAt": "2019-08-24T14:15:22Z", "isAdmin": true }, "warmup": { "provider": "string", "status": "pending", "statusLabel": "string", "strategy": { "preset": "conservative", "startingVolume": 1, "dailyIncrease": 1, "targetVolume": 1, "replyInbox": [ 0, 0 ], "replyPromotions": [ 0, 0 ], "replySpam": 0 }, "strategyApplied": true, "day": 0, "currentVolume": 0, "targetVolume": 0, "health": "excellent", "healthLabel": "string", "healthScore": 0, "inboxRate": 0, "startedAt": "2019-08-24T14:15:22Z", "holdUntil": "2019-08-24T14:15:22Z", "holdReason": "warming", "holdOverride": true, "syncedAt": "2019-08-24T14:15:22Z", "error": "string" }, "restoredFrom": "string" } ], "paging": { "limit": 0, "offset": 0 }}Get a mailbox hosted connect link GET
What became of a mailbox link: `pending` while it is open, `connected` once a mailbox came out of it (`accountId` names it), `failed` when the person cancelled, `expired` once its window closed. Never returns the link URL or its token.
Pause a mailbox POST
Pause the mailbox: campaigns stop emailing from it until it is resumed. Its campaign leads stay assigned. Pausing an already-paused mailbox is a no-op and still returns the mailbox. Emits an `account.paused` webhook with `channel: email`.