Skip to main content
GET
/
campaigns
cURL
curl --request GET \
  --url https://api.wapikit.com/api/campaigns
{
  "campaigns": [
    {
      "uniqueId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "organizationId": "<string>",
      "status": "Draft",
      "sentAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "scheduledAt": "2023-11-07T05:31:56Z",
      "lists": [
        {
          "name": "<string>",
          "description": "<string>",
          "numberOfContacts": 123,
          "numberOfCampaignsSent": 123,
          "tags": [
            {
              "label": "<string>",
              "uniqueId": "<string>"
            }
          ],
          "uniqueId": "<string>",
          "createdAt": "2023-11-07T05:31:56Z"
        }
      ],
      "templateMessageId": "<string>",
      "isLinkTrackingEnabled": true,
      "phoneNumberInUse": "<string>",
      "tags": [
        {
          "label": "<string>",
          "uniqueId": "<string>"
        }
      ],
      "templateComponentParameters": {
        "header": [
          {
            "nameOrIndex": "<string>",
            "label": "<string>",
            "parameterType": "static",
            "dynamicField": "<string>",
            "staticValue": "<string>",
            "example": "<string>",
            "placeholder": "<string>"
          }
        ],
        "body": [
          {
            "nameOrIndex": "<string>",
            "label": "<string>",
            "parameterType": "static",
            "dynamicField": "<string>",
            "staticValue": "<string>",
            "example": "<string>",
            "placeholder": "<string>"
          }
        ],
        "buttons": [
          {
            "nameOrIndex": "<string>",
            "label": "<string>",
            "parameterType": "static",
            "dynamicField": "<string>",
            "staticValue": "<string>",
            "example": "<string>",
            "placeholder": "<string>"
          }
        ],
        "catalogId": "<string>",
        "productRetailerId": "<string>",
        "productSections": [
          {
            "title": "<string>",
            "productItems": [
              {
                "productRetailerId": "<string>"
              }
            ]
          }
        ]
      },
      "stats": {
        "totalRecipients": 123,
        "messagesSent": 123,
        "messagesFailed": 123,
        "messagesDelivered": 123,
        "messagesUndelivered": 123,
        "messagesRead": 123,
        "totalMessages": 123,
        "conversationInitiated": 123,
        "responseRate": 123,
        "openRate": 123,
        "engagementRate": 123,
        "totalLinkClicks": 123,
        "engagementTrends": [
          {
            "date": "2023-11-07T05:31:56Z",
            "label": "<string>",
            "count": 123
          }
        ],
        "linkClicksData": [
          {
            "date": "2023-11-07T05:31:56Z",
            "label": "<string>",
            "count": 123
          }
        ],
        "messageAnalytics": [
          {
            "date": "2023-11-07T05:31:56Z",
            "label": "<string>",
            "sent": 123,
            "delivered": 123,
            "replied": 123,
            "read": 123
          }
        ]
      },
      "progress": {
        "totalMessages": 123,
        "sent": 123
      }
    }
  ],
  "paginationMeta": {
    "page": 123,
    "per_page": 123,
    "total": 123
  }
}

Query Parameters

​
page
integer
required

number of records to skip

​
per_page
integer
required

max number of records to return per page

​
order
enum<string>

order by asc or desc

Available options:
asc,
desc
​
status
enum<string>

sort by a field

Available options:
Draft,
Scheduled,
Running,
Paused,
Cancelled,
Finished

Response

list of campaigns

​
campaigns
object[]
required
​
paginationMeta
object
required