Mailboxes

Get mailbox by ID

Returns detailed information about a specific mailbox.

Set include_credentials=true to get SMTP and IMAP connection details.

get/api/v1/mailboxes/{mailboxId}

Request

  • Base URL: https://api.aerosend.io
  • URL: https://api.aerosend.io/api/v1/mailboxes/{mailboxId}
  • Auth: API key in header X-API-Key

Path parameters

mailboxIdinteger required

Mailbox ID

Query parameters

include_credentialsboolean

Include SMTP/IMAP credentials

Response

Successfully retrieved mailbox

successboolean

Success flag

timestampstring

Response timestamp

Example response

{
  "success": true,
  "data": {
    "id": 456,
    "email": "john@example.com",
    "first_name": "John",
    "last_name": "Doe",
    "status": "active",
    "created_at": "2025-12-01T10:30:00Z",
    "updated_at": "2025-12-10T15:45:00Z",
    "domain_id": 123,
    "domain": "example.com",
    "credentials": {
      "smtp": {
        "host": "smtp.topdeliverabilityninja.com",
        "port": 587,
        "username": "john@example.com",
        "security": "TLS"
      },
      "imap": {
        "host": "smtp.topdeliverabilityninja.com",
        "port": 587,
        "username": "john@example.com",
        "security": "TLS"
      }
    },
    "tags": [
      {
        "id": 789,
        "name": "client-abc",
        "display_name": "Client ABC",
        "color": "#000369",
        "status": "active",
        "domain_count": 10,
        "mailbox_count": 45,
        "created_at": "2025-12-01T10:30:00Z",
        "updated_at": "2025-12-10T15:45:00Z"
      }
    ]
  },
  "timestamp": "2025-12-14T10:30:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.