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

# List campaigns

`GET /campaigns`

Returns a list of campaigns in a paginated manner. Each object in the `collection` represents a Campaign.
This endpoint should always return a result even if there are zero campaigns in the collection.

## Query parameters

- `per_page` integer
- `ending_before` string
- `starting_after` string
- `scopes` object

## Response `200`

OK

- object
  - `per_page` integer — Number of objects that are present in the collection.
  - `total` integer — Total number of objects.
  - `links` object
    - `previous` string, nullable — Link to the previous set of results.
    - `next` string, nullable — Link to the next set of results.
  - `collection` Campaign[]
    - `id` integer — The ID of the resource.
    - `created_at` string, date-time — The date and time when the resource was created.
    - `updated_at` string, date-time — The date and time when the resource was last updated.
    - `name` string — The name of the campaign.
    - `status` 'draft' | 'scheduled' | 'sending' | 'sent' — The campaign's status.
    - `template` BaseTemplate
      - `id` integer — The ID of the resource.
      - `created_at` string, date-time — The date and time when the resource was created.
      - `updated_at` string, date-time — The date and time when the resource was last updated.
      - `name` string — The name of the template.
      - `subject_part` string — The subject part.
    - `schedule` CampaignSchedule
      - `id` string — The ID of the resource.
      - `scheduled_at` string, date-time — The date and time when the campaign is scheduled to be sent.
      - `created_at` string, date-time — The date and time when the resource was created.
      - `updated_at` string, date-time — The date and time when the resource was last updated.
    - `started_at` string, date-time — The date and time when the campaign was started.
    - `completed_at` string, date-time — The date and time when the campaign was completed (the e-mail has been sent to all of the subscribers).

## Other responses

- `401` — Unauthorized
- `default` — Unexpected error

## Changes

- **2021-11-30** `17c65a731b7b` — 2 warning
  - removed the optional property `allOf[subschema #2]/collection/items/allOf[subschema #2]/template/anyOf[#/components/schemas/BaseTemplate]/allOf[subschema #2]/user_id` from the response with the `200` status
  - removed the optional property `allOf[subschema #2]/collection/items/allOf[subschema #2]/user_id` from the response with the `200` status
- **2021-06-15** `4a5e5935c381` — 1 info
  - endpoint added
- **2021-05-18** `c686bd33a4a5` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/mailbadger/apis/mailbadger-api/changes/campaigns/get.md)

---

[API](https://skmtc.dev/mailbadger/apis/mailbadger-api.md) · [All operations](https://skmtc.dev/mailbadger/apis/mailbadger-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/mailbadger/mailbadger-api/revisions/3a7ef49250a1/schema)