Email Accounts

List mailboxes

List your mailboxes, newest first, with stable cursor pagination. Filter by status or tags (any-of), or pass email to look one mailbox up by its address instead of by id.

Requires one of the following scopes: accounts:read, accounts:all, all:read, all:all.

get/v1/accounts

Request

  • Base URL: https://api.mailbeast.ai
  • URL: https://api.mailbeast.ai/v1/accounts
  • Auth: HTTP bearer

Query parameters

cursorstring
Example:eyJ0cyI6IjIwMjYtMDctMDJUMDA6MDA6MDAuMDAwWiIsImlkIjoiM2YxYzJiN2UtOWE0ZC00ZTE4LWIyYzEtNmQ4ZjVhMGU3YzkzIn0

Opaque cursor from a previous response’s meta.nextCursor.

limitnumber
Example:50
status'active' | 'inactive' | 'checking' | 'revoked' | 'failed'

Filter by lifecycle status.

emailstring
Example:jane@acme.com

Look a mailbox up by its address (exact, case-insensitive) instead of by id. Returns at most one mailbox, or an empty data array if you have no mailbox with that address.

tagsstring
Example:5c9b1e77-2f4a-4c31-9d8e-1a2b3c4d5e6f,7a1d2e88-3b5c-4d62-8e9f-2b3c4d5e6f70

Only mailboxes carrying at least ONE of these tag ids (comma-separated). Read the ids from tags[] on any mailbox; tags themselves are managed in the dashboard.

Response

Example response

{
  "data": [
    {
      "id": "3f1c2b7e-9a4d-4e18-b2c1-6d8f5a0e7c93",
      "emailAddress": "jane@acme.com",
      "firstName": "Jane",
      "lastName": "Doe",
      "displayName": "Jane Doe",
      "provider": "custom",
      "maxEmailsPerDay": 30,
      "sendingGapMinutes": 10,
      "replyToAddress": "replies@acme.com",
      "signature": "Best regards,<br>Jane",
      "bcc": "archive@acme.com",
      "automationLanguage": "en",
      "warmup": {
        "enabled": true,
        "strategy": "standard",
        "maxPerDay": 15,
        "replyRatePercentage": 35,
        "rampupEnabled": true,
        "dailyRampup": 1,
        "timezone": "Europe/London",
        "trackingEnabled": true
      },
      "tracking": {
        "domainId": "9d1f7c4a-6e58-4b32-8a07-3c5d9e2f1b46"
      },
      "statusMessage": {
        "code": "EENVELOPE",
        "command": "DATA",
        "responseCode": 550,
        "response": "550-5.4.5 Daily user sending limit exceeded.",
        "message": "Daily user sending limit exceeded"
      },
      "tags": [
        {
          "id": "5c9b1e77-2f4a-4c31-9d8e-1a2b3c4d5e6f",
          "name": "client-acme",
          "color": "#4F46E5"
        }
      ],
      "healthScore": 98,
      "smtp": {
        "host": "smtp.acme.com",
        "port": 587,
        "username": "jane@acme.com"
      },
      "imap": {
        "host": "imap.acme.com",
        "port": 993,
        "username": "jane@acme.com"
      }
    }
  ],
  "meta": {
    "hasMore": true,
    "nextCursor": "eyJ0cyI6IjIwMjYtMDctMDJUMDA6MDA6MDAuMDAwWiIsImlkIjoiM2YxYzJiN2UtOWE0ZC00ZTE4LWIyYzEtNmQ4ZjVhMGU3YzkzIn0"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.