List accounts

API referenceAccounts

From the Accounts API reference. Requests use the base URL https://app.warmerly.com/api/v1 and an API key, see Authentication.

text

GET /accounts

Returns the accounts for a single project when X-Project-Id is set. If you omit X-Project-Id, this endpoint falls back to returning every account across all projects in your active workspace (the one named in X-Workspace-Id if you belong to it, otherwise your own workspace): useful for a workspace-wide overview. Mailboxes whose hosted subscription has been cancelled are left out.

Add ?view=summary for a lighter list with only id, email, provider, status, todayQuota, lastHealthScore, needsReconnect, campaignSendingPausedAt, managedBy, warmupStartedAt and createdAt.

bash

curl https://app.warmerly.com/api/v1/accounts \
  -H "X-Api-Key: wmv_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "X-Project-Id: 8f14e45f-ceea-4c6a-8c8d-6b1a5b5c9c1a"

json

{
  "accounts": [
    {
      "id": "3a6f9e2e-4b7a-4e9a-9b1d-6e3a2f8c1a10",
      "email": "sales@yourdomain.com",
      "provider": "custom",
      "status": "aging",
      "todayQuota": 4,
      "sentToday": 2,
      "campaignSendBlocked": false
    }
  ]
}

The default view returns the full account object plus baseQuota and todayQuota (today's warmup target), sentToday, receivedToday and todayPlan (today's warmup numbers) and, when X-Project-Id is set, campaignSendBlocked (true when the campaign engine will never send a campaign from that mailbox). The example above shows only some of those fields.

Was this page helpful?

List accounts

More from Accounts