Skip to main content
GET
/
campaigns
List Campaigns
curl --request GET \
  --url https://api-prod.syntr.co/api/v1/email-marketing/campaigns \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "data": {
    "campaigns": [
      {
        "id": "ea22-9913",
        "name": "Black Friday Push",
        "status": "delivered",
        "total_recipients": 45000
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 10,
      "total": 1,
      "pages": 1
    }
  }
}

​
URL Parameters

​
page
INTEGER
Page number
​
status
STRING
Filter: draft, scheduled, sending, completed, failed, paused, cancelled
​
search
STRING
Search in name or subject
​
template_id
UUID
Filter by template
​
created_by
UUID
Filter by creator user ID
​
date_from
DATE
Filter by start date (ISO)
​
date_to
DATE
Filter by end date (ISO)
{
  "success": true,
  "data": {
    "campaigns": [
      {
        "id": "ea22-9913",
        "name": "Black Friday Push",
        "status": "delivered",
        "total_recipients": 45000
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 10,
      "total": 1,
      "pages": 1
    }
  }
}