ChatofyDevelopers
REST APIMCP Server (AI)New
API KeysWebhooks
Chatofy API
/
Getting Started
API Resources
API v1.0 Live
Developer APICampaignsList Campaigns

List Campaigns

Retrieves all campaigns with real-time analytics. Each campaign includes delivery stats and engagement metrics.

GET/api/v1/campaigns

Query Parameters

3 parameters
statusstringrequired

Filter: completed, processing, queued, failed.

limitnumberrequired

Max per page (default: 20).

pagenumberrequired

Page number (default: 1).

Response Payload

200 OKapplication/json
successbooleanrequired

Whether request succeeded

data.campaigns[].iduuidrequired

Campaign UUID

data.campaigns[].namestringrequired

Campaign name

Example:Summer Promo 2026
data.campaigns[].statusstringrequired

Campaign status

data.campaigns[].template_namestringrequired

WhatsApp template used

data.campaigns[].header_media_urlstring | nulloptional

Public HTTPS media URL for IMAGE/VIDEO/DOCUMENT template header

data.campaigns[].header_filenamestring | nulloptional

Custom document filename for DOCUMENT template header

data.campaigns[].campaign_analyticsarrayrequired

Delivery statistics array

pagination.totalnumberrequired

Total campaigns

pagination.pagenumberrequired

Current page

pagination.pagesnumberrequired

Total pages

Code Snippets & Examples

1curl -X GET "https://app.chatofy.in/api/v1/campaigns?limit=20&page=1" \
2 -H "Authorization: Bearer YOUR_API_KEY"

Was this endpoint guide helpful?

Previous Endpoint
Create Template
Next Endpoint
Get Campaign
© 2026 Chatofy Cloud Platform. All rights reserved.
1curl -X GET "https://app.chatofy.in/api/v1/campaigns?limit=20&page=1" \
2 -H "Authorization: Bearer YOUR_API_KEY"
200 OKapplication/json
1{
2 "success": true,
3 "message": "Campaigns retrieved successfully",
4 "data": {
5 "campaigns": [
6 {
7 "id": "e4443e21-aaaa-0000-0000-000000000001",
8 "name": "Summer Promo 2026",
9 "status": "completed",
10 "template_name": "summer_sale_2026",
11 "created_at": "2026-06-10T13:30:00+05:30",
12 "campaign_analytics": [
13 {
14 "sent_count": 500,
15 "delivered_count": 498,
16 "read_count": 350,
17 "replied_count": 45,
18 "failed_count": 2,
19 "queued_count": 0
20 }
21 ]
22 }
23 ],
24 "pagination": {
25 "total": 3,
26 "page": 1,
27 "limit": 20,
28 "pages": 1
29 }
30 }
31}