Chatofy API

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[].campaign_analyticsarrayrequired

Delivery statistics array

pagination.totalnumberrequired

Total campaigns

pagination.pagenumberrequired

Current page

pagination.pagesnumberrequired

Total pages

Code Snippets & Examples

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

Was this endpoint guide helpful?

Enterprise SLA•99.99% Guaranteed

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

200 OKapplication/json

{
  "success": true,
  "message": "Campaigns retrieved successfully",
  "data": {
    "campaigns": [
      {
        "id": "e4443e21-aaaa-0000-0000-000000000001",
        "name": "Summer Promo 2026",
        "status": "completed",
        "template_name": "summer_sale_2026",
        "created_at": "2026-06-10T08:00:00.000Z",
        "campaign_analytics": [
          {
            "sent_count": 500,
            "delivered_count": 498,
            "read_count": 350,
            "replied_count": 45,
            "failed_count": 2,
            "queued_count": 0
          }
        ]
      }
    ],
    "pagination": {
      "total": 3,
      "page": 1,
      "limit": 20,
      "pages": 1
    }
  }
}

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[].campaign_analyticsarrayrequired

Delivery statistics array

pagination.totalnumberrequired

Total campaigns

pagination.pagenumberrequired

Current page

pagination.pagesnumberrequired

Total pages

Code Snippets & Examples

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

Was this endpoint guide helpful?

Enterprise SLA•99.99% Guaranteed

{ "success": true, "message": "Campaigns retrieved successfully", "data": { "campaigns": [ { "id": "e4443e21-aaaa-0000-0000-000000000001", "name": "Summer Promo 2026", "status": "completed", "template_name": "summer_sale_2026", "created_at": "2026-06-10T08:00:00.000Z", "campaign_analytics": [ { "sent_count": 500, "delivered_count": 498, "read_count": 350, "replied_count": 45, "failed_count": 2, "queued_count": 0 } ] } ], "pagination": { "total": 3, "page": 1, "limit": 20, "pages": 1 } } }