logo
MailboxesList 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&tagMode=any&untagged=true&search=example_string&warmupEnabled=true&warmupStatus=not_started&warmupHealth=good&minBounceRate=3.14&maxBounceRate=3.14&highBounceRate=true&minHealthScore=42&maxHealthScore=42&campaignIds=665b1c2d3e4f5a6b7c8d9e0f,665b1c2d3e4f5a6b7c8d9e10&notInCampaign=true&inActiveCampaign=true&connectionType=oauth&cursor=665b1c2d3e4f5a6b7c8d9e0f&limit=42" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY"
{
  "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": "in_progress",
        "currentDay": 30,
        "currentVolume": 25,
        "metrics": {
          "totalEmailsSent": 36,
          "inboxRate": 96,
          "spamRate": 0,
          "promotionsRate": 0,
          "replyRate": 0,
          "totalRepliesReceived": 6,
          "blockRate": 0,
          "bounceRate": 0,
          "deferralRate": 0,
          "openRate": 0,
          "lastCalculatedAt": "2025-06-01T18:25:50.741Z"
        }
      },
      "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": "not_started"
      },
      "tags": [],
      "bounceRate": 0,
      "totalSent": 200,
      "setupStatus": {
        "healthScore": 75
      },
      "lastError": null,
      "createdAt": "2025-05-15T14:00:00.000Z"
    }
  ],
  "pagination": {
    "limit": 25,
    "total": 2,
    "hasMore": false,
    "nextCursor": "665b1c2d3e4f5a6b7c8d9e10"
  }
}
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_...)
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 (or all, if tagMode=all) of the tags

query
tagModestring

Tag matching mode. "any" returns mailboxes with at least one of the tags, "all" requires all tags to be present. Default "any".

Options: any, all
query
untaggedstring

When "true", returns only mailboxes with no tags

Options: true
query
warmupEnabledstring

Filter by whether warmup is enabled (true) or disabled (false)

Options: true, false
query
warmupStatusstring

Filter by warmup status

Options: not_started, in_progress, paused, completed, stopped, failed
query
warmupHealthstring

Filter by warmup health based on inbox placement rate. - good: inbox rate ≥ 80% - warning: inbox rate 50–79% - poor: inbox rate < 50%

Options: good, warning, poor
query
minBounceRatenumber

Minimum bounce rate (e.g. 0.05 for 5%). Returns mailboxes with bounceRate ≥ this value.

query
maxBounceRatenumber

Maximum bounce rate. Returns mailboxes with bounceRate ≤ this value.

query
highBounceRatestring

Shortcut filter - when "true", returns mailboxes with bounceRate ≥ 5%

Options: true
query
minHealthScoreinteger

Minimum DNS health score (0–100). Returns mailboxes with setupStatus.healthScore ≥ this value.

Min: 0 • Max: 100
query
maxHealthScoreinteger

Maximum DNS health score (0–100). Returns mailboxes with setupStatus.healthScore ≤ this value.

Min: 0 • Max: 100
query
campaignIdsstring

Comma-separated campaign IDs - returns only mailboxes assigned to the specified campaigns

query
notInCampaignstring

When "true", returns only mailboxes that are not assigned to any campaign

Options: true
query
inActiveCampaignstring

When "true", returns only mailboxes currently used in active campaigns

Options: true
query
connectionTypestring

Filter by connection type

Options: oauth, smtp
query
cursorstring

Cursor for pagination - use the nextCursor value from the previous response to fetch the next page

query
limitinteger

Items per page (default 25, max 100)

Min: 1 • Max: 100
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_...)

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 (or all, if tagMode=all) of the tags

tagModestring

Tag matching mode. "any" returns mailboxes with at least one of the tags, "all" requires all tags to be present. Default "any".

Allowed values:anyall
untaggedstring

When "true", returns only mailboxes with no tags

Allowed values:true
warmupEnabledstring

Filter by whether warmup is enabled (true) or disabled (false)

Allowed values:truefalse
warmupStatusstring

Filter by warmup status

Allowed values:not_startedin_progresspausedcompletedstoppedfailed
warmupHealthstring

Filter by warmup health based on inbox placement rate.

  • good: inbox rate ≥ 80%
  • warning: inbox rate 50–79%
  • poor: inbox rate < 50%
Allowed values:goodwarningpoor
minBounceRatenumber

Minimum bounce rate (e.g. 0.05 for 5%). Returns mailboxes with bounceRate ≥ this value.

maxBounceRatenumber

Maximum bounce rate. Returns mailboxes with bounceRate ≤ this value.

highBounceRatestring

Shortcut filter - when "true", returns mailboxes with bounceRate ≥ 5%

Allowed values:true
minHealthScoreinteger

Minimum DNS health score (0–100). Returns mailboxes with setupStatus.healthScore ≥ this value.

maxHealthScoreinteger

Maximum DNS health score (0–100). Returns mailboxes with setupStatus.healthScore ≤ this value.

campaignIdsstring

Comma-separated campaign IDs - returns only mailboxes assigned to the specified campaigns

notInCampaignstring

When "true", returns only mailboxes that are not assigned to any campaign

Allowed values:true
inActiveCampaignstring

When "true", returns only mailboxes currently used in active campaigns

Allowed values:true
connectionTypestring

Filter by connection type

Allowed values:oauthsmtp
cursorstring

Cursor for pagination - use the nextCursor value from the previous response to fetch the next page

limitinteger

Items per page (default 25, max 100)

Responses

successboolean
dataarray
paginationobject