Skip to main content
GET
/
api
/
v1
/
email-accounts
curl "https://server.smartlead.ai/api/v1/email-accounts/?api_key=YOUR_KEY&limit=50&emailWarmupStatus=ACTIVE&isSmtpSuccess=true"

[
  {
    "id": 123,
    "created_at": "2025-01-15T10:30:00.000Z",
    "updated_at": "2025-11-26T08:00:00.000Z",
    "user_id": 456,
    "from_name": "John Doe",
    "from_email": "john@example.com",
    "minTimeToWaitInMins": 5,
    "username": "john@example.com",
    "password": "encrypted_password",
    "smtp_host": "smtp.gmail.com",
    "smtp_port": 587,
    "smtp_port_type": "TLS",
    "message_per_day": 50,
    "different_reply_to_address": null,
    "is_different_imap_account": false,
    "imap_username": "john@example.com",
    "imap_password": "encrypted_password",
    "imap_host": "imap.gmail.com",
    "imap_port": 993,
    "imap_port_type": "SSL",
    "signature": "<p>Best regards,<br>John</p>",
    "custom_tracking_domain": null,
    "bcc_email": null,
    "is_smtp_success": true,
    "is_imap_success": true,
    "smtp_failure_error": null,
    "imap_failure_error": null,
    "type": "GMAIL",
    "daily_sent_count": 25,
    "client_id": null,
    "campaign_count": 3,
    "warmup_details": {
      "status": "ACTIVE",
      "total_sent_count": 450,
      "total_spam_count": 2,
      "warmup_reputation": "95%",
      "warmup_key_id": 789,
      "warmup_created_at": "2025-01-15T10:30:00.000Z",
      "reply_rate": 15,
      "blocked_reason": null
    }
  }
]

Documentation Index

Fetch the complete documentation index at: https://api.smartlead.ai/llms.txt

Use this file to discover all available pages before exploring further.

Returns email accounts with SMTP/IMAP credentials, warmup status, and campaign associations. Supports filtering by connection status, warmup state, email provider, and usage status.

​
Query Parameters

​
api_key
string
required
Your SmartLead API key
​
offset
number
default:"0"
Pagination offset (minimum: 0)
​
limit
number
default:"100"
Number of accounts to return per page (minimum: 1, maximum: 100)
​
isInUse
string
Filter by usage status. Valid values: true (used in campaigns), false (not used in campaigns)
​
emailWarmupStatus
string
Filter by warmup status. Valid values: ACTIVE, INACTIVE
​
isSmtpSuccess
string
Filter by SMTP connection status. Valid values: true (connected), false (failed)
​
isWarmupBlocked
string
Filter by warmup blocked status. Valid values: true (blocked), false (not blocked)
​
esp
string
Filter by email service provider. Valid values: GMAIL, OUTLOOK, SMTP
​
username
string
Filter by email username (partial match supported)
​
client_id
number
Filter by client ID (for multi-tenant accounts)
curl "https://server.smartlead.ai/api/v1/email-accounts/?api_key=YOUR_KEY&limit=50&emailWarmupStatus=ACTIVE&isSmtpSuccess=true"

​
Response Fields

The response is an array of email account objects, each containing:
​
id
number
Unique email account identifier
​
from_name
string
Display name for outgoing emails
​
from_email
string
Email address
​
username
string
Email account username
​
type
string
Account type: GMAIL, OUTLOOK, or SMTP
​
client_id
number | null
Associated client ID
​
campaign_count
number
Number of campaigns using this email account
​
created_at
timestamp
When the account was added
​
updated_at
timestamp
When the account was last updated
​
smtp_host
string
SMTP server hostname
​
smtp_port
number
SMTP server port
​
smtp_port_type
string
SMTP port type (SSL/TLS/STARTTLS)
​
is_smtp_success
boolean
Whether SMTP connection is successful
​
smtp_failure_error
string | null
SMTP connection error message if failed
​
imap_host
string
IMAP server hostname
​
imap_port
number
IMAP server port
​
imap_port_type
string
IMAP port type (SSL/TLS)
​
imap_username
string
IMAP username
​
is_different_imap_account
boolean
Whether IMAP uses different credentials than SMTP
​
is_imap_success
boolean
Whether IMAP connection is successful
​
imap_failure_error
string | null
IMAP connection error message if failed
​
message_per_day
number
Maximum messages allowed per day
​
daily_sent_count
number
Messages sent today
​
signature
string | null
Email signature HTML
​
custom_tracking_domain
string | null
Custom domain for tracking links
​
bcc_email
string | null
BCC email address for all outgoing emails
​
different_reply_to_address
string | null
Custom reply-to email address
​
minTimeToWaitInMins
number
Minimum time to wait between emails (in minutes)
​
warmup_details
object | null
Email warmup status and metrics

​
Response Codes

​
200
Success
Email accounts retrieved successfully
​
401
Unauthorized
Invalid or missing API key
​
422
Validation Error
Invalid query parameters (check limit range and filter values)
​
500
Internal Server Error
Server error occurred
[
  {
    "id": 123,
    "created_at": "2025-01-15T10:30:00.000Z",
    "updated_at": "2025-11-26T08:00:00.000Z",
    "user_id": 456,
    "from_name": "John Doe",
    "from_email": "john@example.com",
    "minTimeToWaitInMins": 5,
    "username": "john@example.com",
    "password": "encrypted_password",
    "smtp_host": "smtp.gmail.com",
    "smtp_port": 587,
    "smtp_port_type": "TLS",
    "message_per_day": 50,
    "different_reply_to_address": null,
    "is_different_imap_account": false,
    "imap_username": "john@example.com",
    "imap_password": "encrypted_password",
    "imap_host": "imap.gmail.com",
    "imap_port": 993,
    "imap_port_type": "SSL",
    "signature": "<p>Best regards,<br>John</p>",
    "custom_tracking_domain": null,
    "bcc_email": null,
    "is_smtp_success": true,
    "is_imap_success": true,
    "smtp_failure_error": null,
    "imap_failure_error": null,
    "type": "GMAIL",
    "daily_sent_count": 25,
    "client_id": null,
    "campaign_count": 3,
    "warmup_details": {
      "status": "ACTIVE",
      "total_sent_count": 450,
      "total_spam_count": 2,
      "warmup_reputation": "95%",
      "warmup_key_id": 789,
      "warmup_created_at": "2025-01-15T10:30:00.000Z",
      "reply_rate": 15,
      "blocked_reason": null
    }
  }
]

​
Usage Notes

Passwords are base64 encoded in the response for security. Decode them before use in your SMTP/IMAP clients.
Use filters to find specific accounts:
  • Filter by isSmtpSuccess=false to find accounts with connection issues
  • Filter by isInUse=false to find unused accounts
  • Filter by emailWarmupStatus=ACTIVE to find accounts currently warming up