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

# List all campaigns

`GET /admin/campaigns`

## Request

- Base URL: `https://api.presscart.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.presscart.com/admin/campaigns`
- Auth: HTTP bearer

Retrieve a list of all campaigns.

## Query parameters

- `limit` number, nullable
- `page` number, nullable
- `order_by` 'asc' | 'desc'
- `sort_by` string
- `include_archived` 'true' | 'false'
- `search` string
- `profile_id` string, uuid: Scope results to campaigns belonging to this profile.

## Response `200`

Campaigns retrieved successfully

- object
  - `total_pages` number, required
  - `current_page` number, required
  - `next_page` number, nullable, required
  - `previous_page` number, nullable, required
  - `records` object[], required
    - `id` string, uuid, required
    - `name` string, required
    - `reference` string, nullable, required
    - `profile_id` string, uuid, required
    - `created_at` union, required
      - string, nullable
      - string
      - unknown
    - `updated_at` union, required
      - string, nullable
      - string
      - unknown
    - `deleted_at` union, required
      - string, nullable
      - string
      - unknown
    - `team` object, nullable, required
      - `id` string, uuid, required
      - `name` string, required
    - `profile_name` string, nullable, required
    - `articles` CampaignListArticle[], required
      - `id` string, uuid, required
      - `name` string, required
      - `campaign_id` string, uuid, required
      - `live_url` string, nullable, required
      - `writer` object, nullable, required
        - `id` string, uuid, required
        - `first_name` string, required
        - `last_name` string, required
      - `status` object[], required
        - `name` string, required
        - `prefix` string, required
        - `color` string, nullable, required
        - `effective_at` union, required
          - string, nullable
          - string
          - unknown
        - `notes` string, nullable
      - `order_item` object, nullable, required
        - `name` string, required
        - `outlet` object, nullable, required
          - `name` string, required
          - `logo` string, nullable, required
          - `file_attachments` object[], required
            - `file_key` string, required
            - `file_name` string, required
            - `file_url` string, required
        - `addons` object[], required
          - `name` string, required
          - `is_niche` boolean, required: True for a niche surcharge, which is not a writing service.
    - `questionnaire` object, nullable, required
      - `id` string, uuid, required
      - `campaign_id` string, uuid, required
      - `objectives` string, required
      - `keywords` string, nullable, required
      - `target_audience` string, nullable, required
      - `tone` string, nullable, required
      - `writing_samples` string, nullable, required
      - `file_id` string, nullable, required
      - `file_name` string, nullable, required
      - `file_size` number, nullable, required
      - `file_url` string
      - `created_at` union, required
        - string, nullable
        - string
        - unknown
      - `updated_at` union, required
        - string, nullable
        - string
        - unknown
      - `deleted_at` union, required
        - string, nullable
        - string
        - unknown
    - `total_articles` number, nullable
  - `total_records` number, required

---

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