> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developers.hive.co/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.hive.co/_mcp/server.

# List SMS campaigns

GET https://api.hive.co/v2/campaigns/sms/

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.

Reference: https://developers.hive.co/api-reference/hive-api/campaigns/sms-retrieve

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Query parameters

- `limit` (integer, optional, default: 50)
- `offset` (integer, optional, default: 0)
- `stats` (boolean, optional, default: false)

### Headers

- `X-Partner-Id` (string, required) — Your OAuth application client ID.

## Response

### 200

- `offset` (integer, required)
- `limit` (integer, required)
- `total_items` (integer, required)
- `items` (list of SMSCampaignWithStats, required)

## Errors

### 422 Unprocessable Entity Error

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.

- `map from string to any`

## Types

### SMSCampaignWithStats

- `id` (string, required)
- `name` (string, required, nullable)
- `time_sent` (datetime, required, nullable)
- `num_recipients` (integer, required, nullable)
- `stats_refreshed_at` (datetime, required, nullable)
- `stats` (SMSCampaignStats, optional, nullable) — 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.

### 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, optional)
- `rates` (SMSCampaignEngagementRates, optional)
- `revenue` (SMSCampaignRevenue, optional)

### SMSCampaignEngagementCounts

- `sent` (integer, optional, default: 0)
- `delivered` (integer, optional, default: 0)
- `clicked` (integer, optional, default: 0)
- `failed` (integer, optional, default: 0)
- `opted_out` (integer, optional, default: 0)
- `opted_in` (integer, optional, default: 0)
- `undeliverable` (integer, optional, default: 0)

### SMSCampaignEngagementRates

- `delivery_rate` (double, optional)
- `click_rate` (double, optional)
- `opt_out_rate` (double, optional)
- `failed_rate` (double, optional)

### SMSCampaignRevenue

- `ecommerce` (CampaignChannelRevenue, optional)
- `ticketing` (CampaignChannelRevenue, optional)
- `total` (CampaignChannelRevenue, optional)

### CampaignChannelRevenue

- `num_orders` (integer, optional, default: 0)
- `total_revenue` (double, optional, default: 0)

## Examples

**Response**

```json
{
  "offset": 1,
  "limit": 1,
  "total_items": 1,
  "items": [
    {
      "id": "string",
      "name": "string",
      "time_sent": "2024-01-15T09:30:00Z",
      "num_recipients": 1,
      "stats_refreshed_at": "2024-01-15T09:30:00Z",
      "stats": {
        "counts": {
          "sent": 0,
          "delivered": 0,
          "clicked": 0,
          "failed": 0,
          "opted_out": 0,
          "opted_in": 0,
          "undeliverable": 0
        },
        "rates": {
          "delivery_rate": 1.1,
          "click_rate": 1.1,
          "opt_out_rate": 1.1,
          "failed_rate": 1.1
        },
        "revenue": {
          "ecommerce": {
            "num_orders": 0,
            "total_revenue": 0
          },
          "ticketing": {
            "num_orders": 0,
            "total_revenue": 0
          },
          "total": {
            "num_orders": 0,
            "total_revenue": 0
          }
        }
      }
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.hive.co/v2/campaigns/sms/"

headers = {
    "X-Partner-Id": "X-Partner-Id",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.hive.co/v2/campaigns/sms/';
const options = {
  method: 'GET',
  headers: {'X-Partner-Id': 'X-Partner-Id', Authorization: 'Bearer <token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hive.co/v2/campaigns/sms/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Partner-Id", "X-Partner-Id")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.hive.co/v2/campaigns/sms/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Partner-Id"] = 'X-Partner-Id'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.hive.co/v2/campaigns/sms/")
  .header("X-Partner-Id", "X-Partner-Id")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.hive.co/v2/campaigns/sms/', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'X-Partner-Id' => 'X-Partner-Id',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.hive.co/v2/campaigns/sms/");
var request = new RestRequest(Method.GET);
request.AddHeader("X-Partner-Id", "X-Partner-Id");
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "X-Partner-Id": "X-Partner-Id",
  "Authorization": "Bearer <token>"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.hive.co/v2/campaigns/sms/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```