List Emails
Retrieve a paginated list of transactional emails sent by your organization, each with an aggregate per-status count.
Endpoint
GET /email
Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
limit | number | 20 | Items per page (min: 1, max: 100) |
after | string | — | Cursor — return items after this id (exclusive). |
before | string | — | Cursor — return items before this id (exclusive). |
Results are returned newest first. See Pagination for cursor details.
Response
{
"object": "list",
"has_more": true,
"data": [
{
"id": "01957e3a-4b5c-7d8e-9f0a-1b2c3d4e5f6a",
"from": "noreply@yourdomain.com",
"from_name": "My App",
"subject": "Welcome to our platform",
"category": "welcome",
"status": {
"sent": 1,
"delivered": 1,
"opened": 0,
"clicked": 0,
"bounced": 0,
"complained": 0,
"rejected": 0,
"unsubscribed": 0,
"render_failure": 0
},
"created_at": "2026-03-08T12:00:00.000Z"
}
]
}
Status Fields
Each field is a count of unique recipients that reached that status. Status values match the per-recipient values returned by GET /email/:id:
| Field | Description |
|---|---|
sent | Messages accepted by the mail provider |
delivered | Messages confirmed delivered to the recipient's inbox |
opened | Unique opens tracked |
clicked | Unique recipients that clicked a tracked link |
bounced | Messages that bounced (hard or soft) |
complained | Recipients who marked the email as spam |
rejected | Messages rejected by the mail provider before delivery |
unsubscribed | Recipients who unsubscribed via the email's unsubscribe link |
render_failure | Template rendering failed for the recipient |
tip
The subject field returns null if the email content has been purged (content retention policy).
Examples
- cURL
- JavaScript
- Python
- C#
- PHP
curl "https://api.arsel.sa/v1/email?limit=10" \
-H "Authorization: Bearer be_your_api_key"
const response = await fetch(
"https://api.arsel.sa/v1/email?limit=10",
{
headers: { Authorization: "Bearer be_your_api_key" },
}
);
const { data, has_more } = await response.json();
console.log(`Got ${data.length} emails; more available: ${has_more}`);
for (const email of data) {
console.log(`${email.id}: ${email.status.delivered} delivered, ${email.status.bounced} bounced`);
}
import requests
response = requests.get(
"https://api.arsel.sa/v1/email",
headers={"Authorization": "Bearer be_your_api_key"},
params={"limit": 10},
)
result = response.json()
for email in result["data"]:
status = email["status"]
print(f"{email['id']}: {status['delivered']} delivered, {status['bounced']} bounced")
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer be_your_api_key");
var response = await client.GetAsync("https://api.arsel.sa/v1/email?limit=10");
var json = await response.Content.ReadAsStringAsync();
Console.WriteLine(json);
<?php
$ch = curl_init("https://api.arsel.sa/v1/email?limit=10");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer be_your_api_key"
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$data = json_decode($response, true);
foreach ($data["data"] as $email) {
$status = $email["status"];
echo "{$email['id']}: {$status['delivered']} delivered, {$status['bounced']} bounced\n";
}
curl_close($ch);