List Campaigns
List your organization's push campaigns, newest first.
Endpoint
GET /push/campaigns
Returns: 200 OK
Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
search | string | — | Filter by campaign name. |
status | string | all | Draft, Scheduled, Queued, Sending, Paused, Sent, Failed, Cancelled, Archived. |
limit | integer | 20 | Items per page, 1–100. |
after | string | — | Return items after this id (exclusive). |
before | string | — | Return items before this id (exclusive). |
See Pagination for how cursor paging works.
Headers
| Header | Value | Required |
|---|---|---|
Authorization | Bearer <your-api-key> | Yes |
Response
{
"object": "list",
"has_more": false,
"data": [
{
"id": "0192a1b2-c3d4-7e5f-9000-abcdef123456",
"name": "Flash sale — 6h only",
"title": "Doors close at midnight",
"body": "Everything 40% off for the next six hours.",
"status": "Sent",
"scheduled_at": null,
"sent_at": "2026-09-01T09:05:00.000Z",
"created_at": "2026-08-10T12:00:00.000Z",
"updated_at": "2026-09-01T09:05:00.000Z"
}
]
}
Each item has the same shape as the Create Campaign response.
Examples
- cURL
- JavaScript
- Python
- C#
- PHP
curl "https://api.arsel.sa/v1/push/campaigns?status=Sent&limit=50" \
-H "Authorization: Bearer $ARSEL_API_KEY"
const response = await fetch("https://api.arsel.sa/v1/push/campaigns?status=Sent&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/push/campaigns?status=Sent&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/push/campaigns?status=Sent&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/push/campaigns?status=Sent&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"
}