List SMS campaigns

GET/api/v1/sms/campaigns

GET /sms/campaigns

curl -X GET 'https://www.unitpost.com/api/v1/sms/campaigns' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Response · 200

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "object": "sms_campaign",
      "id": "id_123",
      "name": "Example",
      "status": "draft",
      "type": "marketing",
      "template_id": "template_123",
      "segment_id": "segment_123",
      "sender_id": "sender_123",
      "topic_id": "topic_123",
      "routing": "automatic",
      "scheduled_at": "2026-01-01T00:00:00.000Z",
      "hold": {
        "reason": "scheduled",
        "until": "string"
      },
      "projected_recipients": {
        "total": 1,
        "reachable": 0,
        "skipped": 0
      },
      "recipient_count": 1,
      "variable_fallbacks": {},
      "excluded_contact_ids": [
        "string"
      ],
      "started_at": "2026-01-01T00:00:00.000Z",
      "completed_at": "2026-01-01T00:00:00.000Z",
      "canceled_at": "2026-01-01T00:00:00.000Z",
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Retrieve your SMS campaigns, newest first and cursor-paginated. Deleted (archived) campaigns are hidden; pass ?archived=true to list only archived ones. Requires the campaigns:read capability.

Parameters4 fields

Field	Type	Description
`limit`	integer · query	Max rows to return (default 20, max 100).
`after`	string · query	Return rows after this id (forward paging).
`before`	string · query	Return rows before this id (backward paging).
`archived`	boolean · query	When true, list only archived SMS campaigns instead of active ones.

Response · 200 fields21 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`name`required	string	—
`status`required	enumdraft \| scheduled \| sending \| paused \| sent \| canceled \| failed	—
`type`required	enummarketing \| transactional	—
`template_id`required	string	—
`segment_id`required	string	—
`sender_id`required	string \| null	—
`topic_id`required	string \| null	—
`routing`required	enumautomatic \| fixed \| pool	—
`scheduled_at`required	string \| null	—
`hold`required	object \| null	—
`projected_recipients`required	object \| null	—
`recipient_count`required	number	—
`variable_fallbacks`required	object	—
`excluded_contact_ids`required	string[]	—
`started_at`required	string \| null	—
`completed_at`required	string \| null	—
`canceled_at`required	string \| null	—
`created_at`required	string	—
`updated_at`required	string	—

200401403404422

List SMS campaigns

List SMS campaigns

Search docs and guides