GET /api/campaigns/{id} Returns the full details of a single campaign, enriched with the linked template name, channel types, and recipient count.

​
Headers

​
appid
string
required
Your CometChat App ID.
​
apikey
string
required
Your CometChat API Key.

​
Path parameters

​
id
string
required
The campaign ID.

​
Example request

curl https://{appId}.api-{region}.cometchat.io/v3/business-messaging/api/campaigns/666c3d4e5f6a7b8c9d0e1f2a \
  -H "appid: YOUR_APP_ID" \
  -H "apikey: YOUR_API_KEY"

​
Example response

{
  "id": "666c3d4e5f6a7b8c9d0e1f2a",
  "appId": "YOUR_APP_ID",
  "name": "January Promo",
  "templateId": "665b2c3d4e5f6a7b8c9d0e1f",
  "templateName": "Order Confirmation",
  "channelTypes": ["in_app", "push"],
  "status": "sent",
  "deliveryMode": "batch",
  "tag": "promo",
  "recipientCount": 1500,
  "scheduledAt": null,
  "createdAt": "2024-01-15T09:30:00.000Z",
  "updatedAt": "2024-01-16T10:00:00.000Z"
}

​
Response fields

​
id
string
Unique campaign identifier.
​
name
string
Campaign display name.
​
templateName
string
Enriched template display name.
​
channelTypes
string[]
Array of channel types from the linked template.
​
status
string
Campaign status: draft, scheduled, sending, sent, or failed.
​
recipientCount
integer
Total number of recipients.
​
scheduledAt
string
ISO 8601 scheduled send time, or null.