Get Scheduled Emails
Retrieve a list of scheduled emails with pagination parameters.
This endpoint allows you to retrieve a list of scheduled emails. You can specify pagination parameters to control the number of results returned.
Query Parameters
domainstringoptionalThe domain linked to the scheduled emails. For domain-scoped API keys, this parameter is optional. For application-scoped API keys, it is required and must be one of the domains associated with the API key.
pageintegeroptionalThe page number to retrieve. Defaults to 1 if not specified.
per_pageintegeroptionalThe maximum number of results to return per page. Defaults to 10, max 100.
Sample Request
The following is a sample request to retrieve scheduled emails.
GET https://smtp.maileroo.com/api/v2/emails/scheduled?domain=example.com&page=1&per_page=10Response Structure
successbooleanoptionalIndicates whether the request was successful.
messagestringoptionalA human-readable message describing the result.
dataobjectoptionalContains the paginated results and metadata.
data Object
pagenumberoptionalThe current page number of results.
per_pagenumberoptionalNumber of results returned per page.
total_countnumberoptionalTotal number of results available.
total_pagesnumberoptionalTotal number of pages available.
results[]ResultoptionalAn array where each item represents an email record.
data.results[] (Result)
fromstringoptionalThe sender of the email, including name and email address (e.g., "John Doe" <[email protected]>).
headersobject (map)optionalCustom email headers sent with the email (e.g., X-Priority, X-Campaign, X-Source).
recipients[]stringoptionalList of recipient email addresses.
reference_idstringoptionalUnique reference ID associated with the email.
scheduled_atstring (ISO-8601)optionalDate and time when the email is scheduled for delivery.
subjectstringoptionalThe subject line of the email.
tagsobject (map)optionalKey-value pairs used for categorizing the email (e.g., campaign, region, customer type).
Sample Response
Success
{
"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
}
}Error
{
"data": null,
"message": "You are using an app-based sending API key and must provide a linked domain.",
"success": false
}{
"data": null,
"message": "You are using an app-based sending API key and the domain 'example.com' is not associated with this key.",
"success": false
}