Get Scheduled Emails

This endpoint allows you to retrieve a list of scheduled emails. You can specify pagination parameters to control the number of results returned.

Endpoint

GET https://smtp.maileroo.com/api/v2/emails/scheduled?page=[:number]&per_page=[:number]

Query Parameters

Parameter	Type	Description
page	number	The page number to retrieve. Defaults to 1 if not specified.
per_page	number	The maximum number of results to return per page. Defaults to 10, max 100.

Sample Request

The following is a sample request to send an email.

GET https://smtp.maileroo.com/api/v2/scheduled?page=1&per_page=10

Response Structure

Field	Type	Description
success	boolean	Indicates whether the request was successful.
message	string	A human-readable message describing the result.
data	object	Contains the paginated results and metadata.

---

data Object

Field	Type	Description
page	number	The current page number of results.
per_page	number	Number of results returned per page.
total_count	number	Total number of results available.
total_pages	number	Total number of pages available.
results	[]Result	An array where each item represents an email record.

---

data.results[] (Result)

Field	Type	Description
from	string	The sender of the email, including name and email address (e.g., "John Doe" <[email protected]>).
headers	object (map)	Custom email headers sent with the email (e.g., X-Priority, X-Campaign, X-Source).
recipients	[]string	List of recipient email addresses.
reference_id	string	Unique reference ID associated with the email.
scheduled_at	string (ISO-8601)	Date and time when the email is scheduled for delivery.
subject	string	The subject line of the email.
tags	object (map)	Key-value pairs used for categorizing the email (e.g., campaign, region, customer type).

Sample Response

{
  "success": true,
  "message": "The results have been returned.",
  "data": {
    "page": 1,
    "per_page": 10,
    "results": [
      {
        "from": "\"John Doe\" <[email protected]>",
        "headers": {
          "X-Priority": "High",
          "X-Campaign": "Spring2025",
          "X-Source": "API"
        },
        "recipients": [
          "[email protected]"
        ],
        "reference_id": "abc1234567890abcdef1234",
        "scheduled_at": "2025-07-30T14:00:00Z",
        "subject": "Welcome to our Spring Sale!",
        "tags": {
          "campaign": "spring_sale",
          "region": "us-east",
          "customer_type": "new"
        }
      },
      {
        "from": "\"John Doe\" <[email protected]>",
        "headers": {
          "X-Priority": "Normal",
          "X-Campaign": "Newsletter2025",
          "X-Source": "Automation"
        },
        "recipients": [
          "[email protected]"
        ],
        "reference_id": "def4567890abcdef1234567",
        "scheduled_at": "2025-07-30T14:00:00Z",
        "subject": "Your Monthly Newsletter is Here",
        "tags": {
          "campaign": "newsletter",
          "region": "eu-central",
          "customer_type": "subscriber"
        }
      },
      {
        "from": "\"John Doe\" <[email protected]>",
        "headers": {
          "X-Priority": "Low",
          "X-Campaign": "ProductUpdate",
          "X-Source": "CRM"
        },
        "recipients": [
          "[email protected]"
        ],
        "reference_id": "ghi7890abcdef1234567890",
        "scheduled_at": "2025-07-30T14:00:00Z",
        "subject": "New Features Released – Check Them Out!",
        "tags": {
          "campaign": "product_update",
          "region": "ap-southeast",
          "customer_type": "existing"
        }
      },
      {
        "from": "\"John Doe\" <[email protected]>",
        "headers": {
          "X-Priority": "Normal",
          "X-Campaign": "FeedbackSurvey",
          "X-Source": "API"
        },
        "recipients": [
          "[email protected]"
        ],
        "reference_id": "jkl0123abcdef4567890123",
        "scheduled_at": "2025-07-30T14:00:00Z",
        "subject": "We Value Your Feedback – Take Our Survey",
        "tags": {
          "campaign": "survey",
          "region": "us-west",
          "customer_type": "premium"
        }
      }
    ],
    "total_count": 4,
    "total_pages": 1
  }
}