Campaigns
List campaigns
https://api.smsedge.com/v1/campaigns/getall/Returns your campaigns with their countries, sender IDs and sending totals, newest activity first.
Campaigns are sorted by their latest activity (the later of the creation date and the last message), newest first. Use page and per_page to page through them. pagination.all is the number of pages. A page after the last page returns 200 with an empty data array.
With date_from or date_to, the list holds only campaigns that sent in that period, and the totals count only that period. If you send only one of the two dates, date_to defaults to today and date_from to 30 days before date_to. The period is 366 days max.
ctris a percent (12.5 = 12.5%).leadsandsalesneed a conversion pixel.sender_idslists every sender ID the campaign rotates through, with its sender ID group.sender_idis deprecated and alwaysnull.account_idandaccount_nameshow the owner. With an agency API key, the list includes the campaigns of the agency's customer accounts.
Query params
pageintegeroptionalPage number, starting at 1.
Default:
1per_pageintegeroptionalCampaigns per page. 1,000 max.
Default:
100date_fromstringoptionalReturns only campaigns that sent on or after this date (YYYY-MM-DD).
date_tostringoptionalReturns only campaigns that sent on or before this date (YYYY-MM-DD).
idintegeroptionalReturns only the campaign with this ID.
namestringoptionalReturns only campaigns whose name contains this text.
tagstringoptionalReturns only campaigns whose tag contains this text.
country_idintegeroptionalReturns only campaigns for this country. See List countries.
Responses
- 200A page of campaigns
- 400The dates are invalid. Other messages: "Invalid date_from requested", "Invalid date_to requested", "Invalid Dates requested (date_from is after date_to)".
- 401The API key is missing, wrong or the account is blocked
- 404No campaign matches the filters
curl -X GET "https://api.smsedge.com/v1/campaigns/getall/?page=1&per_page=50" \
-H "X-API-KEY: YOUR_API_KEY"[
{
"success": true,
"data": [
{
"id": 244614,
"name": "UK · 12 Nov",
"tag": null,
"account_id": 736,
"account_name": "demo",
"country": [
{
"id": 225,
"name": "United Kingdom"
}
],
"sender_id": null,
"sender_ids": [
{
"name": "MyBrand",
"group": "UK1"
},
{
"name": "MyShop",
"group": "UK1"
}
],
"created": "2026-11-12 20:20:11",
"laps": "2",
"previews": 0,
"sent": 1699,
"clicks": 15,
"ctr": 0.88,
"leads": 0,
"sales": 0,
"cost": 69.98,
"sending_activity": {
"from": "2026-11-12 20:25:03",
"to": "2026-11-13 10:41:57"
}
},
{
"id": 244542,
"name": "IT · 12 Nov",
"tag": null,
"account_id": 736,
"account_name": "demo",
"country": [
{
"id": 105,
"name": "Italy"
}
],
"sender_id": null,
"sender_ids": [],
"created": "2026-11-12 13:53:25",
"laps": "0",
"previews": 0,
"sent": 0,
"clicks": 0,
"ctr": 0,
"leads": 0,
"sales": 0,
"cost": 0,
"sending_activity": {
"from": null,
"to": null
}
}
],
"errors": [],
"pagination": {
"page": "1",
"all": 27,
"per_page": 2,
"total": 54
},
"response": {
"code": 200,
"description": "OK",
"date": "2026-11-16 13:58:22"
},
"api": {
"version": "v1",
"module": "campaigns",
"function": "getall"
},
"user": {
"id": 736
}
}
]All requests need your API key in the X-API-KEY header. See Authentication.