logo
MailboxesGet mailbox detail
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"
{
  "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"
  }
}
GET
/v1/mailboxes/{id}
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
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

Path Parameters

idstring
Required

Resource ID

Responses

successboolean
dataobject

Full mailbox object (credentials excluded)