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

# List campaigns

`GET /v1/campaigns`

## Request

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

## Query parameters

- `status` string
- `search` string
- `sort` string
- `page` integer
- `per_page` integer

## Response `200`

Filtered by status

- ApiV1CampaignCollectionResponse
  - `data` object[], required
    - `id` string, required
    - `type` 'campaign', required
    - `attributes` object, required
      - `name` string, required
      - `status` string, required
      - `behaviour` string, nullable
      - `start_time` string, nullable
      - `end_time` string, nullable
      - `time_zone` string, nullable
      - `created_at` string, required
      - `updated_at` string, required
      - `signature_templates_count` integer, required
  - `meta` ApiV1Meta, required
    - `request_id` string, required

## Other responses

- `401`: Unauthorized

---

[API](https://skmtc.dev/scribe-mail/apis/scribe-public-api.md) · [All operations](https://skmtc.dev/scribe-mail/apis/scribe-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/scribe-mail/apis/scribe-public-api/revisions/2ab8476d37d5?raw)
