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¬InCampaign=true&inActiveCampaign=true&connectionType=oauth&cursor=665b1c2d3e4f5a6b7c8d9e0f&limit=42" \
-H "Content-Type: application/json" \
-H "X-Api-Key: YOUR_API_KEY"
import requests
import json
url = "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¬InCampaign=true&inActiveCampaign=true&connectionType=oauth&cursor=665b1c2d3e4f5a6b7c8d9e0f&limit=42"
headers = {
"Content-Type": "application/json",
"X-Api-Key": "YOUR_API_KEY"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("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¬InCampaign=true&inActiveCampaign=true&connectionType=oauth&cursor=665b1c2d3e4f5a6b7c8d9e0f&limit=42", {
method: "GET",
headers: {
"Content-Type": "application/json",
"X-Api-Key": "YOUR_API_KEY"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("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¬InCampaign=true&inActiveCampaign=true&connectionType=oauth&cursor=665b1c2d3e4f5a6b7c8d9e0f&limit=42", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-Api-Key", "YOUR_API_KEY")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('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¬InCampaign=true&inActiveCampaign=true&connectionType=oauth&cursor=665b1c2d3e4f5a6b7c8d9e0f&limit=42')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['X-Api-Key'] = 'YOUR_API_KEY'
response = http.request(request)
puts response.body
{
"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"
}
}
/v1/mailboxes
Platform API key (sk_user_...) or Workspace API key (sk_...)
Filter by mailbox status
Filter by email provider
Filter by sending enabled/disabled
Tag matching mode. "any" returns mailboxes with at least one of the tags, "all" requires all tags to be present. Default "any".
When "true", returns only mailboxes with no tags
Search by email or display name (case-insensitive partial match)
Filter by whether warmup is enabled (true) or disabled (false)
Filter by warmup status
Filter by warmup health based on inbox placement rate. - good: inbox rate ≥ 80% - warning: inbox rate 50–79% - poor: inbox rate < 50%
Minimum bounce rate (e.g. 0.05 for 5%). Returns mailboxes with bounceRate ≥ this value.
Maximum bounce rate. Returns mailboxes with bounceRate ≤ this value.
Shortcut filter - when "true", returns mailboxes with bounceRate ≥ 5%
Minimum DNS health score (0–100). Returns mailboxes with setupStatus.healthScore ≥ this value.
Maximum DNS health score (0–100). Returns mailboxes with setupStatus.healthScore ≤ this value.
Comma-separated campaign IDs - returns only mailboxes assigned to the specified campaigns
When "true", returns only mailboxes that are not assigned to any campaign
When "true", returns only mailboxes currently used in active campaigns
Filter by connection type
Cursor for pagination - use the nextCursor value from the previous response to fetch the next page
Items per page (default 25, max 100)
Request Preview
Response
Response will appear here after sending the request
Authentication
API Key for authentication. Platform API key (sk_user_...) or Workspace API key (sk_...)
Query Parameters
Filter by mailbox status
activeinactiveerrorwarming_upsuspendedfailedpendingTag matching mode. "any" returns mailboxes with at least one of the tags, "all" requires all tags to be present. Default "any".
anyallSearch by email or display name (case-insensitive partial match)
Filter by whether warmup is enabled (true) or disabled (false)
truefalseFilter by warmup status
not_startedin_progresspausedcompletedstoppedfailedFilter by warmup health based on inbox placement rate.
- good: inbox rate ≥ 80%
- warning: inbox rate 50–79%
- poor: inbox rate < 50%
goodwarningpoorMinimum bounce rate (e.g. 0.05 for 5%). Returns mailboxes with bounceRate ≥ this value.
Maximum bounce rate. Returns mailboxes with bounceRate ≤ this value.
Shortcut filter - when "true", returns mailboxes with bounceRate ≥ 5%
trueMinimum DNS health score (0–100). Returns mailboxes with setupStatus.healthScore ≥ this value.
Maximum DNS health score (0–100). Returns mailboxes with setupStatus.healthScore ≤ this value.
Comma-separated campaign IDs - returns only mailboxes assigned to the specified campaigns
When "true", returns only mailboxes that are not assigned to any campaign
trueWhen "true", returns only mailboxes currently used in active campaigns
trueCursor for pagination - use the nextCursor value from the previous response to fetch the next page
Items per page (default 25, max 100)
Responses
gmailoutlookazurecustomactiveinactiveerrorwarming_upsuspendedfailedpendingsmtpoauthnot_startedin_progresspausedcompletedstoppedfailedDNS health score (0-100)
Last updated 4 days ago
Built with Documentation.AI