List Emails
Retrieve a paginated list of transactional emails sent by your organization, each with an aggregate per-status count.
Endpoint
GET /email
Returns: 200 OK
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 $ARSEL_API_KEY"
const response = await fetch("https://api.arsel.sa/v1/email?limit=10", {
headers: {
Authorization: `Bearer ${process.env.ARSEL_API_KEY}`,
},
});
const data = await response.json();
if (!response.ok) {
throw new Error(`${data.name}: ${data.message}`);
}
console.log(data);
import os
import requests
response = requests.get(
"https://api.arsel.sa/v1/email?limit=10",
headers={"Authorization": f"Bearer {os.environ['ARSEL_API_KEY']}"},
)
response.raise_for_status()
print(response.json())
using System.Net.Http.Headers;
var client = new HttpClient(); // share one instance across requests
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue(
"Bearer", Environment.GetEnvironmentVariable("ARSEL_API_KEY"));
var response = await client.GetAsync("https://api.arsel.sa/v1/email?limit=10");
var body = await response.Content.ReadAsStringAsync();
if (!response.IsSuccessStatusCode)
throw new HttpRequestException($"{(int)response.StatusCode}: {body}");
Console.WriteLine(body);
<?php
$ch = curl_init("https://api.arsel.sa/v1/email?limit=10");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("ARSEL_API_KEY"),
],
]);
$data = json_decode(curl_exec($ch), true);
if (curl_getinfo($ch, CURLINFO_HTTP_CODE) >= 400) {
throw new Exception("{$data['name']}: {$data['message']}");
}
print_r($data);
Error Responses
- 401 Unauthorized
{
"status_code": 401,
"name": "unauthorized",
"message": "Invalid API Key"
}