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"
import requests
import json
url = "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"
headers = {
"Content-Type": "application/json",
"X-Api-Key": "YOUR_API_KEY",
"Authorization": "Bearer YOUR_API_TOKEN"
}
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&search=example_string&page=25&limit=42&cursor=example_string", {
method: "GET",
headers: {
"Content-Type": "application/json",
"X-Api-Key": "YOUR_API_KEY",
"Authorization": "Bearer YOUR_API_TOKEN"
}
});
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&search=example_string&page=25&limit=42&cursor=example_string", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-Api-Key", "YOUR_API_KEY")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
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&search=example_string&page=25&limit=42&cursor=example_string')
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'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
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": "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
}
}
/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
Search by email or display name (case-insensitive partial match)
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
API Key for authentication. Platform API key (sk_user_...) or Workspace API key (sk_...)
Bearer token. API key as Bearer token
Query Parameters
Filter by mailbox status
activeinactiveerrorwarming_upsuspendedfailedpendingSearch by email or display name (case-insensitive partial match)
Cursor ID for cursor-based pagination (use instead of page for large datasets)
Responses
Last updated today
Built with Documentation.AI