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

# List SMS campaigns

`GET /campaigns/sms/`

## Request

- Base URL: `https://api.hive.co/v2`
- URL: `https://api.hive.co/v2/campaigns/sms/`
- Auth: HTTP bearer

Sent SMS campaigns for the authorized brand, most recently sent first. `stats` is only present when requested with `stats=true`; compare `stats_refreshed_at` to avoid re-fetching unchanged stats.

## Query parameters

- `limit` integer
- `offset` integer
- `stats` boolean

## Headers

- `X-Partner-Id` string, required

## Response `200`

- PaginatedSMSCampaigns
  - `offset` integer, required
  - `limit` integer, required
  - `total_items` integer, required
  - `items` SMSCampaignWithStats[], required
    - `id` string, required
    - `name` string, nullable, required
    - `time_sent` string, date-time, nullable, required
    - `num_recipients` integer, nullable, required
    - `stats_refreshed_at` string, date-time, nullable, required
    - `stats` SMSCampaignStats: Explicit, versioned view over the stats dict assembled by SMSCampaignsService. The cached subdocuments are never passed through, so internal key changes can't break API consumers.
      - `counts` SMSCampaignEngagementCounts
        - `sent` integer
        - `delivered` integer
        - `clicked` integer
        - `failed` integer
        - `opted_out` integer
        - `opted_in` integer
        - `undeliverable` integer
      - `rates` SMSCampaignEngagementRates
        - `delivery_rate` number, double
        - `click_rate` number, double
        - `opt_out_rate` number, double
        - `failed_rate` number, double
      - `revenue` SMSCampaignRevenue
        - `ecommerce` CampaignChannelRevenue
          - `num_orders` integer
          - `total_revenue` number, double
        - `ticketing` CampaignChannelRevenue
          - `num_orders` integer
          - `total_revenue` number, double
        - `total` CampaignChannelRevenue
          - `num_orders` integer
          - `total_revenue` number, double

## Other responses

- `422`: The request was rejected on its query parameters. Field errors are keyed by parameter name, rejections on the parameter values (e.g. an unknown ID) use a flat `errors` list.

---

[API](https://skmtc.dev/hive-co/apis/hive-api.md) - [All operations](https://skmtc.dev/hive-co/apis/hive-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hive-co/apis/hive-api/revisions/aa145f089347?raw)