Mailboxes
Get mailbox detail
Returns full mailbox details excluding sensitive credentials (oauthCredentials, smtpCredentials, imapCredentials).
curl -X GET "https://api.sendkit.ai/v1/mailboxes/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/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/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/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/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@company.com",
"displayName": "Sarah Johnson",
"provider": "custom",
"status": "active",
"connectionType": "smtp",
"dailySendLimit": 40,
"sentToday": 12,
"sendingEnabled": true,
"signature": "<p>Best regards,<br>Sarah Johnson</p>",
"smtpHost": "smtp.company.com",
"smtpPort": 587,
"smtpSecure": false,
"imapHost": "imap.company.com",
"imapPort": 993,
"imapSecure": true,
"warmup": {
"enabled": true,
"status": "in_progress",
"currentDay": 15,
"currentVolume": 25,
"config": {
"startingVolume": 10,
"dailyIncrease": 1,
"targetVolume": 25
},
"metrics": {}
},
"tags": [
"outreach"
],
"bounceRate": 0.02,
"totalSent": 500,
"totalReceived": 50,
"setupStatus": {
"healthScore": 100,
"mx": {
"status": "pass"
},
"spf": {
"status": "pass"
},
"dkim": {
"status": "pass"
},
"dmarc": {
"status": "pass"
}
},
"lastError": null,
"createdAt": "2025-06-10T10:30:00.000Z",
"updatedAt": "2025-06-15T14:00:00.000Z"
}
}
{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Mailbox not found"
}
}
GET
/v1/mailboxes/{id}GET
API Key (header: X-Api-Key)
X-Api-Keystring
RequiredPlatform API key (sk_user_...) or Workspace API key (sk_...)
Platform API key (sk_user_...) or Workspace API key (sk_...)
path
idstring
RequiredResource ID
Request Preview
Response
Response will appear here after sending the request
Authentication
header
X-Api-Keystring
RequiredAPI Key for authentication. Platform API key (sk_user_...) or Workspace API key (sk_...)
header
Authorizationstring
RequiredBearer token. API key as Bearer token
Path Parameters
idstring
RequiredResource ID
Responses
successboolean
dataobject
Full mailbox object (credentials excluded)
Was this page helpful?
Last updated today
Built with Documentation.AI