Skip to main content
GET
/
api
/
campaigns
/
{id}
Get campaign by ID
curl --request GET \
  --url https://your-instance.example.com/api/campaigns/{id} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "_id": "665f1a0c0e0a4b001a2c9f10",
    "name": "Q2 Lead Gen",
    "status": "sent",
    "stats": {
      "total": 250,
      "sent": 248,
      "failed": 2,
      "successRate": "99.2%"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Response

Campaign returned

​
success
boolean
​
data
object
Example:
{
  "_id": "665f1a0c0e0a4b001a2c9f10",
  "organizationId": "64ee9a8b1e7f2a0011223344",
  "name": "Q2 Lead Gen",
  "message": "Hi {{firstName}}, are you still interested in a quote?",
  "userIds": ["64ee9a8b1e7f2a0011223399"],
  "scheduleDate": "2026-05-20T15:00:00.000Z",
  "process": "64eea1110000000000000001",
  "contactStatus": "New Lead",
  "isAutopilot": false,
  "type": "sms",
  "status": "scheduled",
  "createdBy": {
    "_id": "64ee9a8b1e7f2a0011223399",
    "fullName": "Alex Rep"
  },
  "failedUserIds": [],
  "failedDetails": [],
  "stats": {
    "total": 250,
    "sent": 0,
    "failed": 0,
    "successRate": "0%"
  },
  "createdAt": "2026-05-18T12:34:56.000Z",
  "updatedAt": "2026-05-18T12:34:56.000Z"
}