Retrieving an Email

GET /emails/{emailId}

Description

Retrieves the details of a specific email account from the warmup pool, identified by its unique ID. The response includes all relevant information such as current status, settings, and statistics.

Request

const response = await fetch(`https://partners.leadwarm.ai/api/v1/emails/${emailId}`, {
    method: "GET",
    headers: {
        "Content-Type": "application/json",
        Authorization: `Bearer ${YOUR_API_KEY}`,
    },
});

Parameters

emailId (required): The unique identifier of the email to retrieve.

Example Response

{
    "id": "b9cf7c28-422b-43f6-b4d9-542080cb9103",
    "sending_limit": 50,
    "sending_increase": 3,
    "current_sending_amount": 24,
    "sending_active": true,
    "last_email_sent": "2024-01-01 18:00:00",
    "score": 75,
    "emails_sent": 3243,
    "emails_saved": 12,
    "smtp_domain": "smtp.example.com",
    "smtp_port": 587,
    "smtp_tls": false,
    "imap_domain": "imap.example.com",
    "imap_port": 993,
    "imap_tls": true
}

200 OK: Successfully retrieved the email details.
404 Not Found: No email found with the provided identifier.
401 Unauthorized: Authentication credentials are not provided or are invalid.

Retrieve all Emails Adding an Email