---
title: "List SMS campaigns"
method: GET
path: "/sms/campaigns"
tags: ["SMS campaigns"]
---

# List SMS campaigns

`GET /sms/campaigns`

## Request

- Base URL: `https://www.unitpost.com/api/v1`
- URL: `https://www.unitpost.com/api/v1/sms/campaigns`
- Auth: HTTP bearer

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.

## Query parameters

- `limit` integer
- `after` string
- `before` string
- `archived` boolean

## Response `200`

A page of SMS campaigns.

- object
  - `object` 'list', required
  - `has_more` boolean, required
  - `data` SmsCampaign[], required
    - `object` 'sms_campaign', required
    - `id` string, required
    - `name` string, required
    - `status` 'draft' | 'scheduled' | 'sending' | 'paused' | 'sent' | 'canceled' | 'failed', required
    - `type` 'marketing' | 'transactional', required
    - `template_id` string, required
    - `segment_id` string, required
    - `sender_id` string, nullable, required
    - `topic_id` string, nullable, required
    - `routing` 'automatic' | 'fixed' | 'pool', required
    - `scheduled_at` string, nullable, required
    - `hold` object, nullable, required
      - `reason` 'scheduled' | 'quiet_hours', required
      - `until` string, nullable, required
    - `projected_recipients` object, nullable, required
      - `total` number, required
      - `reachable` number, required
      - `skipped` number, required
    - `recipient_count` number, required
    - `variable_fallbacks` object, required
    - `excluded_contact_ids` string[], required
    - `started_at` string, nullable, required
    - `completed_at` string, nullable, required
    - `canceled_at` string, nullable, required
    - `created_at` string, required
    - `updated_at` string, required

## Other responses

- `401`: Missing or invalid API key.
- `403`: Insufficient scope, or SMS is not on this plan.
- `404`: SMS campaign not found, or SMS is not enabled.
- `422`: Invalid pagination params.

---

[API](https://skmtc.dev/unitpost/apis/unitpost-api.md) · [All operations](https://skmtc.dev/unitpost/apis/unitpost-api/llms.txt) · [OpenAPI document](https://skmtc.dev/unitpost/apis/unitpost-api/revisions/86ff7c890967?raw)