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

# List campaigns

`GET /v1/campaigns`

This endpoint shows all campaigns that are available for the shop.
Campaigns are used to allow temporary discounts on products.
After the indexing process completes, campaign details become immediately available. However, developers should be cautious. Before displaying a campaign, always validate the 'start_at' and 'end_at' fields. Failure to do so might result in campaigns displaying earlier than intended.

## Query parameters

- `sort` 'id' | 'reduction' | 'start_at' | 'end_at'
- `sortDir` 'asc' | 'desc'
- `page` integer
- `perPage` integer
- `limit` integer
- `offset` integer

## Response `200`

successful operation

- CampaignsResponse
  - `pagination` union
    - Pagination
      - `current` integer, required
      - `first` integer, required
      - `last` integer, required
      - `next` integer, required
      - `page` integer, required
      - `perPage` integer, required
      - `prev` integer, required
      - `total` integer, required
    - OffsetPagination
      - `total` integer, required
  - `entities` Campaign[]
    - `id` integer
    - `name` string
    - `key` string
    - `description` string
    - `reduction` integer
    - `customData` object
    - `start_at` string
    - `end_at` string

## Other responses

- `401` — authentication failed

---

[API](https://skmtc.net/scayle/apis/storefront-api-documentation.md) · [All operations](https://skmtc.net/scayle/apis/storefront-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/scayle/storefront-api-documentation/revisions/8cfa924ae703/schema)