---
title: "Your campaigns and where each stands"
method: GET
path: "/campaigns"
---

# Your campaigns and where each stands

`GET /campaigns`

## Request

- Base URL: `https://app.distribution.tech/api/v1`
- URL: `https://app.distribution.tech/api/v1/campaigns`
- Auth: HTTP bearer

Scope: campaigns:read.

## Query parameters

- `include_archived` boolean

## Response `200`

OK

- Campaigns
  - `campaigns` CampaignSummary[], required
    - `id` string, uuid, required
    - `display_name` string, required: The campaign's name as the workspace shows it: the product, else the company, shortened; Untitled campaign when neither is set (a plan started from one creator).
    - `company` string, nullable, required
    - `product` string, nullable, required
    - `objective` string, nullable, required
    - `created_at` string, date-time, required
    - `plan_status` 'awaiting_approval' | 'approved' | 'null', nullable, required
    - `open_change` boolean, required
    - `intent_status` 'draft' | 'ready' | 'null', nullable, required
    - `stage_id` 'draft' | 'sent' | 'plan_ready' | 'approved' | 'paid' | 'running' | 'complete' | 'cancelled', required: draft (not sent), sent (no plan yet), plan_ready (a plan waits for approval), approved (signed, not paid), paid (the brand's payment cleared, no post started), running (a post is scheduled, live or delayed), complete (every post has its proof), cancelled (the order was cancelled or refunded).
    - `stage` 'Draft' | 'Sent' | 'Plan ready' | 'Approved' | 'Paid' | 'Running' | 'Complete' | 'Cancelled' | 'Archived', required
    - `waits_on_you` boolean, required: The campaign needs the brand: approve its plan, or pay its signed plan. A draft is never counted.
    - `refunded_at` string, date-time, nullable, required: When the order was refunded; null unless it was (the workspace shows Cancelled, refunded on this date).
    - `archived_at` string, date-time, nullable, required: When the brand archived the campaign; null for a live one. An archived campaign's stage reads Archived, and renaming it or setting its creator guidelines is refused (409 conflict, reason archived).

## Other responses

- `400`: A parameter this list does not take (limit, offset or any other), or include_archived that is not true or false: details.problems names each one. Since 1.9.0; before, such a parameter was ignored.
- `401`: No API key, an unknown one, or a revoked one.
- `403`: The key does not have this endpoint's scope.
- `429`: Too many requests for this key in the current minute (60); Retry-After and RateLimit-Reset say when to try again. On POST /campaigns and on POST /plans/current/lines when it starts a plan: the brand's 3 new campaigns in 24 hours are used (details.reason daily_campaign_limit); details.resets_at and Retry-After say when the limit reopens, a rolling 24 hours from the first of them, not a calendar day; archiving or deleting a campaign does not give its slot back. On GET /creators and GET /creators/{id}: a creator read limit is used (details.reason per_minute, daily_lists, daily_reveals, daily_seen or locked). daily_seen is your workspace's one pool of 300 creator views a day (300 different creators shown or opened since midnight UTC), shared by the app and every API key of the brand: details.scope workspace and details.limit 300; a creator already seen today, in the app or through any key, still opens and costs nothing. The other reasons are this key's own limit (details.scope key) or the brand's ceiling over all its keys (details.scope api).
- `500`: internal: the request failed on our side. Try again.
- `503`: unavailable: the service or this part of it is not reachable right now. Try again shortly.

---

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