logo
MailboxesList mailboxes
Mailboxes

List mailboxes

Returns a paginated list of mailboxes in the workspace with health and warmup data. Sensitive credentials are excluded from responses.

curl -X GET "https://api.sendkit.ai/v1/mailboxes?status=active&provider=gmail&sendingEnabled=true&tags=example_string&search=example_string&page=25&limit=42&cursor=example_string" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "success": true,
  "data": [
    {
      "_id": "665b1c2d3e4f5a6b7c8d9e0f",
      "email": "sarah@sendkit.ai",
      "displayName": "Sarah",
      "provider": "gmail",
      "status": "active",
      "connectionType": "oauth",
      "dailySendLimit": 50,
      "sentToday": 12,
      "sendingEnabled": true,
      "signature": "<p>Best regards,<br>Sarah</p>",
      "warmup": {
        "enabled": true,
        "status": "completed",
        "currentDay": 30,
        "currentVolume": 25,
        "metrics": {}
      },
      "tags": [
        "outreach",
        "primary"
      ],
      "bounceRate": 0.02,
      "totalSent": 1500,
      "setupStatus": {
        "healthScore": 100
      },
      "lastError": null,
      "createdAt": "2025-05-01T10:00:00.000Z"
    },
    {
      "_id": "665b1c2d3e4f5a6b7c8d9e10",
      "email": "support@company.com",
      "displayName": "Support",
      "provider": "custom",
      "status": "active",
      "connectionType": "smtp",
      "dailySendLimit": 30,
      "sentToday": 5,
      "sendingEnabled": true,
      "signature": null,
      "warmup": {
        "enabled": false,
        "status": "idle"
      },
      "tags": [],
      "bounceRate": 0,
      "totalSent": 200,
      "setupStatus": {
        "healthScore": 75
      },
      "lastError": null,
      "createdAt": "2025-05-15T14:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 25,
    "total": 2,
    "pages": 1
  }
}
GET
/v1/mailboxes
GET
API Key (header: X-Api-Key)
X-Api-Keystring
Required

Platform API key (sk_user_...) or Workspace API key (sk_...)

Platform API key (sk_user_...) or Workspace API key (sk_...)
Bearer Token
Bearer Tokenstring
Required

API key as Bearer token

API key as Bearer token
query
statusstring

Filter by mailbox status

Options: active, inactive, error, warming_up, suspended, failed, pending
query
providerstring

Filter by email provider

Options: gmail, outlook, azure, custom
query
sendingEnabledstring

Filter by sending enabled/disabled

Options: true, false
query
tagsstring

Comma-separated tag names — returns mailboxes matching any of the tags

query
limitinteger
Min: 1 • Max: 100
query
cursorstring

Cursor ID for cursor-based pagination (use instead of page for large datasets)

Request Preview
Response

Response will appear here after sending the request

Authentication

header
X-Api-Keystring
Required

API Key for authentication. Platform API key (sk_user_...) or Workspace API key (sk_...)

header
Authorizationstring
Required

Bearer token. API key as Bearer token

Query Parameters

statusstring

Filter by mailbox status

Allowed values:activeinactiveerrorwarming_upsuspendedfailedpending
providerstring

Filter by email provider

Allowed values:gmailoutlookazurecustom
sendingEnabledstring

Filter by sending enabled/disabled

Allowed values:truefalse
tagsstring

Comma-separated tag names — returns mailboxes matching any of the tags

cursorstring

Cursor ID for cursor-based pagination (use instead of page for large datasets)

Responses

successboolean
dataarray
paginationobject