Skip to main content

List Campaigns

List your organization's push campaigns, newest first.

Endpoint​

GET /push/campaigns

Returns: 200 OK

Query Parameters​

ParameterTypeDefaultDescription
searchstring—Filter by campaign name.
statusstringallDraft, Scheduled, Queued, Sending, Paused, Sent, Failed, Cancelled, Archived.
limitinteger20Items per page, 1–100.
afterstring—Return items after this id (exclusive).
beforestring—Return items before this id (exclusive).

See Pagination for how cursor paging works.

Headers​

HeaderValueRequired
AuthorizationBearer <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 "https://api.arsel.sa/v1/push/campaigns?status=Sent&limit=50" \
-H "Authorization: Bearer $ARSEL_API_KEY"

Error Responses​

{
"status_code": 401,
"name": "unauthorized",
"message": "Invalid API Key"
}