---
title: "List campaigns by status"
method: GET
path: "/get-campaigns/"
tags: ["Reporting"]
---

# List campaigns by status

`GET /get-campaigns/`

## Request

- Base URL: `http://api.smsfusion.com.au`
- URL: `http://api.smsfusion.com.au/get-campaigns/`
- Auth: one of:
  - API key in query parameter `key`
  - HTTP basic

A few historical rows carry the legacy status misspelling 'canceled' (one l); it is not in the filter whitelist, so those rows appear unfiltered but cannot be filtered for

## Query parameters

- `key` string, required
- `status` 'pending' | 'review' | 'sent' | 'cancelled' | 'draft' | 'sending' | 'low balance'
- `limit` integer
- `offset` integer

## Response `200`

Successfull response

- CampaignItem[]
  - `id` integer
  - `created` integer
  - `scheduled` integer
  - `status` string: pending, review, sent, cancelled, draft, sending, or low balance (historical rows may carry the legacy misspelling canceled)
  - `campaignName` string
  - `list` integer
  - `source` string
  - `segments` integer
  - `interval` integer
  - `validity` integer
  - `messages` string[]
  - `addSubscribeTo` integer
  - `addIncomingTo` integer
  - `addUnsubTo` integer
  - `addClicksTo` integer
  - `supressionLists` integer[]

## Other responses

- `401`: INVALID_STATUS

---

[API](https://skmtc.dev/smsfusion/apis/sms-fusion-api.md) · [All operations](https://skmtc.dev/smsfusion/apis/sms-fusion-api/llms.txt) · [OpenAPI document](https://skmtc.dev/smsfusion/apis/sms-fusion-api/revisions/a88b2793a6e9?raw)