WahideAPI Docs
GET

List Campaigns

Fetch broadcast campaigns, their delivery progress, and schedule states.

HTTP Endpoint

GEThttps://api-wa.hidessh.com/api/v1/campaigns

Authentication

This endpoint requires Bearer authentication via your secret API Key.
Header KeyValueRequired
AuthorizationBearer <your_api_key>Required
Content-Typeapplication/jsonRequired

Request Parameters

The request body must be formatted as JSON with the following parameters:

ParameterTypeRequiredDescription
status
stringOptional

Filter by status: 'DRAFT', 'RUNNING', 'PAUSED', 'COMPLETED'.

example: RUNNING
page
integerOptional

Page number.

default: 1
size
integerOptional

Page size.

default: 10

Code Examples

request.sh
curl -X GET "https://api-wa.hidessh.com/api/v1/campaigns?status=RUNNING" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response Formats

Campaigns array.

application/json • 200 OK
{
  "success": true,
  "payload": [
    {
      "id": "01M1CP001",
      "name": "September Flash Sale Promo",
      "status": "RUNNING",
      "total_recipients": 1200,
      "sent_count": 845,
      "failed_count": 5,
      "device_pool": ["01M1WW3FKR1JS7CW4KGY78Q5ND"]
    }
  ]
}