---
title: "List campaigns and playbooks"
method: GET
path: "/campaigns"
tags: ["Campaigns"]
---

# List campaigns and playbooks

`GET /campaigns`

## Request

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

Newest first, every campaign in the workspace with its roster, limits, `policyVersion` and, for a playbook, its `autoApprove` rule. Filter with `mode=always_on` to find playbooks to reuse. Not paginated.

## Query parameters

- `mode` 'always_on' | 'batch' | 'single'

## Response `200`

Success: `{"data": [Campaign]}`.

- CampaignListResponse: The success body: `{"data": [Campaign]}`.
  - `data` Campaign[], required
    - `id` string, required
    - `status` 'draft' | 'active' | 'paused' | 'completed', required
    - `mode` 'always_on' | 'batch' | 'single', required
    - `monthlyBudgetCents` integer
    - `autoApprove` AutoApprovePolicy: Auto-approve rule a signed-in owner or admin set in the web app. While enabled, a person added to this active playbook whose gift fits perGiftMaxCents, monthlyBudgetCents and the balance is approved and paid from the balance on enabledBy's behalf. Read-only through keys and connections.
      - `enabled` boolean, required
      - `perGiftMaxCents` integer, required
      - `enabledBy` string
      - `enabledAt` string
    - `policyVersion` integer, required
    - `recipients` Recipient[], required
      - `recipientId` string, required
      - `name` string, required
      - `email` string, required
      - `company` string, required
      - `sourceSystem` string
      - `externalId` string
      - `profileUrl` string
      - `importId` string
      - `importRowId` string
      - `addressMode` 'known' | 'confirm'

## Other responses

- `400`: Bad request: `VALIDATION_ERROR`. Each example says when.
- `401`: Not authenticated: `AUTH_REQUIRED`. no credentials, or an OAuth token on a route that only takes workspace keys; the key is malformed, unknown or revoked.
- `429`: Too many requests: `RATE_LIMIT`. more than 240 requests in the current minute for this workspace (REST and MCP share the limit); wait `retryAfterMs`.
- `default`: Any other refusal or failure, such as 403 CSRF (a cross-origin `Origin` header), 403 HTTPS_REQUIRED or 500 INTERNAL_ERROR, with what to do next.

---

[API](https://skmtc.dev/gtmswag/apis/gtm-swag-api.md) · [All operations](https://skmtc.dev/gtmswag/apis/gtm-swag-api/llms.txt) · [OpenAPI document](https://skmtc.dev/gtmswag/apis/gtm-swag-api/revisions/9ff86fa99afe?raw)
