---
title: "List campaigns"
method: GET
path: "/v1/campaigns"
tags: ["Messaging"]
---

# List campaigns

`GET /v1/campaigns`

## Request

- Base URL: `https://api.affiliaterail.com`
- URL: `https://api.affiliaterail.com/v1/campaigns`
- Auth: HTTP bearer

Newest first, with delivery stats. Drafts are composed in the dashboard.

**Scope:** `read`

## Query parameters

- `program_id` string, required

## Response `200`

Campaigns

- CampaignList
  - `data` Campaign[], required
    - `id` string, required: Prefixed id (`camp_…`)
    - `object` 'campaign', required
    - `program_id` string, required: Prefixed id (`prg_…`)
    - `name` string, required
    - `subject` string, required
    - `status` 'draft' | 'scheduled' | 'sending' | 'paused' | 'sent', required
    - `scheduled_at` string, date-time, nullable, required: ISO-8601, UTC
    - `sent_at` string, date-time, nullable, required: ISO-8601, UTC
    - `stats` object, required
      - `total` integer, required
      - `queued` integer, required
      - `sent` integer, required
      - `failed` integer, required
      - `opened` integer, required
      - `skipped` integer, required
    - `created_at` string, date-time, required: ISO-8601, UTC
    - `updated_at` string, date-time, required: ISO-8601, UTC
  - `has_more` boolean, required
  - `total_count` integer, required

## Other responses

- `400`: Invalid request
- `401`: Missing or unknown API key
- `403`: Key lacks the required scope
- `404`: No such object in your organization
- `422`: The request was understood and refused
- `429`: Rate limited: see Retry-After

---

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