List WhatsApp
Retrieve transactional WhatsApp messages sent by your organization, most recent first.
Endpoint
GET /whatsapp
Returns: 200 OK
Transactional only
Campaign sends are not included. This lists only messages sent through POST /whatsapp/send.
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": false,
"data": [
{
"id": "01957e3a-4b5c-7d8e-9f0a-1b2c3d4e5f6a",
"to": "+966512345678",
"template_name": "order_shipped",
"language": "ar",
"category": "UTILITY",
"status": "delivered",
"failure_reason": null,
"sent_at": "2026-03-08T12:00:03.000Z",
"created_at": "2026-03-08T12:00:00.000Z"
}
]
}
Response Fields
| Field | Description |
|---|---|
id | Message ID |
to | Recipient in E.164 format |
template_name | The approved template that was sent |
language | Template language code |
category | MARKETING, UTILITY, or AUTHENTICATION |
status | See Get WhatsApp |
failure_reason | Why the send failed. null unless status is failed. |
sent_at | When the provider accepted the message. null while still queued. |
created_at | When the message was submitted to Arsel |
Template parameters are never returned
parameters is deliberately absent from every response. For an authentication template that field holds the one-time code, and an endpoint that reads codes back out would turn a leaked API key into an account-takeover tool.
Examples
- cURL
- JavaScript
- Python
- C#
- PHP
curl "https://api.arsel.sa/v1/whatsapp?limit=50" \
-H "Authorization: Bearer $ARSEL_API_KEY"
const response = await fetch("https://api.arsel.sa/v1/whatsapp?limit=50", {
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/whatsapp?limit=50",
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/whatsapp?limit=50");
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/whatsapp?limit=50");
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"
}