Campaigns
List campaigns
List the campaigns in your workspace, newest first, each with its live counters (`sentCount`, `deliveredCount`, `readCount`, `failedCount`).
Offset-paginated via limit + skip. Requires campaigns:read.
Request
curl -X GET "https://api.blueticks.co/v1/campaigns"{
"success": true,
"data": [
{
"cmpId": "string",
"name": "string",
"audienceId": "string",
"status": "pending",
"totalCount": 0,
"sentCount": 0,
"deliveredCount": 0,
"readCount": 0,
"failedCount": 0,
"createdAt": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"abortedAt": "2019-08-24T14:15:22Z"
}
],
"limit": 0,
"skip": 0,
"total": 0
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"requestId": "string",
"details": [
{
"path": "string",
"code": "string",
"message": "string"
}
]
}
}Query Parameters
order?string
Sort direction by timestamp: asc (oldest first) or desc (newest first, default).
Default
"desc"Value in
"asc" | "desc"skip?integer
Number of items to skip before the page (default 0).
Default
0Range
0 <= valuelimit?integer
Page size (default 50, max 200).
Default
50Range
1 <= value <= 200Response
Response Body
application/json
application/json