Skip to main content
GET
/
v1
/
sms
/
campaigns
List SMS campaigns
curl --request GET \
  --url https://api.nixflex.com/v1/sms/campaigns
Returns all SMS campaigns for your account, newest first. Each campaign includes computed delivery counts.

Request

curl https://api.nixflex.com/v1/sms/campaigns \
  -H "Authorization: Bearer KEY_ID:KEY_SECRET"

Query parameters

ParameterTypeNotes
limitintDefault 25, max 100
offsetintPagination offset
agent_idstringFilter to one agent
statusenumdraft, scheduled, running, done, failed

Response

{
  "campaigns": [
    {
      "campaign_id": "smsc_a1b2c3d4",
      "name": "March promotion",
      "agent_id": "agent_125207e452f8714a",
      "from_number": "+447446466847",
      "status": "done",
      "total_count": 100,
      "delivered_count": 95,
      "failed_count": 3,
      "pending_count": 2,
      "source": "dashboard",
      "created_at": "2026-05-17T03:45:12Z"
    }
  ],
  "count": 1
}
This is a summary view. Use Get SMS campaign for per-recipient details.

Campaign status values

StatusMeaning
draftCreated but not launched
scheduledWill launch at scheduled_at
runningCurrently sending
doneAll recipients processed
failedAll recipients failed at submission
Counts are computed live from per-recipient status. Same numbers appear in the dashboard, the list endpoint, and the get-one endpoint.