List Message Campaigns

Retrieve a list of messages within a specific date range. Supports filtering by from/to dates.

GET /messages/campaigns

Required Permission

read:BatchSMS

Your API key must have this permission enabled in order to use this endpoint.

Example Request

curl --location 'https://<hostname>/messages/campaigns?fromDate=2025-01-01&toDate=2025-03-01' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'

Replace YOUR_API_KEY with your API key.

All endpoints shown in this documentation use a sample base URL. The production API endpoint is provided by our team upon request.

Response (HTTP 200)

{
  "success": true,
  "records": [
    {
      "id": "8af60d9-de7f-45ce-7f13-5a91bb45277",
      "name": "Test Campaign",
      "recipientCount": 10,
      "scheduled": "2025-01-05T10:00:00.000Z",
      "status": "Completed"
    }
  ],
  "offset": 0,
  "limit": 10,
  "total": 5
}

This endpoint supports sorting and pagination. See Search & Pagination Parameters for details.