Skip to main content
GET
/
campaigns
List all campaigns
curl --request GET \
  --url https://ecsend.paysgator.com/campaigns \
  --header 'X-Api-Key: <api-key>'
[
  {
    "id": "clx456def",
    "name": "Summer Promo",
    "status": "COMPLETED",
    "senderId": "ECSEND",
    "createdAt": "2023-11-07T05:31:56Z",
    "errorMessage": "<string>",
    "recipientCount": 100
  }
]

Authorizations

​
X-Api-Key
string
header
required

Response

List of campaigns

​
id
string
Example:

"clx456def"

​
name
string
Example:

"Summer Promo"

​
status
enum<string>
Available options:
PENDING,
COMPLETED,
FAILED
Example:

"COMPLETED"

​
senderId
string
Example:

"ECSEND"

​
createdAt
string<date-time>
​
errorMessage
string | null
​
recipientCount
integer
Example:

100