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"

import requests
import json

url = "https://api.sendkit.ai/v1/mailboxes/example_string"
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/example_string", {
  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/example_string", 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/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'

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": {
        "totalEmailsSent": 36,
        "inboxRate": 96,
        "spamRate": 0,
        "promotionsRate": 0,
        "replyRate": 0,
        "totalRepliesReceived": 6,
        "blockRate": 0,
        "bounceRate": 0,
        "deferralRate": 0,
        "openRate": 0,
        "lastCalculatedAt": "2025-06-14T18:25:50.741Z"
      }
    },
    "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/{mailboxId}

GET

API Key (header: X-Api-Key)

X-Api-Keystring

Required

Platform API key (sk_user_...) or Workspace API key (sk_...)

path

mailboxIdstring

Required

Mailbox ID

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_...)

Responses

successboolean

dataobject

Full mailbox object (credentials excluded)

_idstring

emailstring

displayNamestring

providerstring

Allowed values:gmailoutlookazurecustom

statusstring

Allowed values:activeinactiveerrorwarming_upsuspendedfailedpending

connectionTypestring

Allowed values:smtpoauth

dailySendLimitinteger

sentTodayinteger

sendingEnabledboolean

signaturestring

smtpHoststring

SMTP host (SMTP mailboxes only)

smtpPortinteger

SMTP port (SMTP mailboxes only)

smtpSecureboolean

SMTP TLS enabled (SMTP mailboxes only)

imapHoststring

IMAP host (SMTP mailboxes only)

imapPortinteger

IMAP port (SMTP mailboxes only)

imapSecureboolean

IMAP TLS enabled (SMTP mailboxes only)

warmupobject

enabledboolean

statusstring

Allowed values:not_startedin_progresspausedcompletedstoppedfailed

currentDayinteger

currentVolumeinteger

configobject

startingVolumeinteger

dailyIncreaseinteger

targetVolumeinteger

metricsobject

totalEmailsSentinteger

inboxRatenumber

spamRatenumber

promotionsRatenumber

replyRatenumber

totalRepliesReceivedinteger

blockRatenumber

bounceRatenumber

deferralRatenumber

openRatenumber

lastCalculatedAtstring

tagsstring[]

bounceRatenumber

totalSentinteger

totalReceivedinteger

setupStatusobject

healthScoreinteger

DNS health score (0-100)

mxobject

statusstring

Allowed values:passfailwarning

spfobject

statusstring

Allowed values:passfailwarning

dkimobject

statusstring

Allowed values:passfailwarning

dmarcobject

statusstring

Allowed values:passfailwarning

lastErrorstring

createdAtstring

updatedAtstring

Mailbox not found

Was this page helpful?

Last updated today

Built with Documentation.AI

{ "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": { "totalEmailsSent": 36, "inboxRate": 96, "spamRate": 0, "promotionsRate": 0, "replyRate": 0, "totalRepliesReceived": 6, "blockRate": 0, "bounceRate": 0, "deferralRate": 0, "openRate": 0, "lastCalculatedAt": "2025-06-14T18:25:50.741Z" } }, "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 mailbox detail

Request Preview

Response

Authentication

Path Parameters

Responses