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

# List Campaigns

`GET /shop/customers/campaigns`

Returns a paginated list of `Campaign`s for the given site.

## Query parameters

- `page` integer
- `per_page` integer
- `site_id` string, uuid, required
- `query` string
- `sort` 'created_at' | '-created_at' | 'updated_at' | '-updated_at' | 'scheduled_at' | '-scheduled_at' | 'sent_at' | '-sent_at'
- `scheduled_at_from` string, date-time
- `scheduled_at_to` string, date-time
- `sent_at_from` string, date-time
- `sent_at_to` string, date-time

## Response `200`

The campaigns were successfully retrieved.

- object
  - `data` Campaign[], required
    - `id` string, uuid, required — The unique identifier of the campaign.
    - `name` string, required — The display name of the campaign.
    - `progress` number, float, nullable, required — The send progress of the campaign as a percentage (0–100). Only populated when `status` is `in_progress`; `null` otherwise.
    - `scheduled_at` string, date-time, nullable, required — The datetime at which this campaign is scheduled to be sent, or `null` if not yet scheduled.
    - `segment` object, nullable, required — A summary of the `CustomerSegment` this campaign is targeting, or `null` if no segment has been assigned.
      - `id` string, uuid, required — The ID of the segment.
      - `name` string, required — The display name of the segment.
    - `sent_at` string, date-time, nullable, required — The datetime at which this campaign was sent, or `null` if it has not yet been sent.
    - `site_id` string, uuid, required
    - `status` 'unsent' | 'in_progress' | 'sent', required — The current send status of the campaign. - `unsent` — no send records exist yet. - `in_progress` — sends have been created but at least one has not yet been sent. - `sent` — all send records have been sent.
  - `meta` PaginationMeta, required — Counts and positional information for the current page of a list response. Use `current_page` and `last_page` to drive pagination UI, `total` for result counts, and `per_page` to confirm the page size the server actually applied (which may differ from the requested value when capped).
    - `from` integer, required — The item number from which this results set starts from
    - `to` integer, required — The item number from which this results set ends at
    - `total` integer, required — The total number of results
    - `current_page` integer, required — The current page number
    - `last_page` integer, required — The page number of the last result set
    - `per_page` integer, required — The number of results per page
    - `path` string, required — The path of this api request
  - `links` PaginationLinks, required — Hypermedia navigation links for paging through a list response. Each property is a fully-qualified URL that preserves the original query string (filters, sort, page size) and only swaps the `page` parameter. `next` and `prev` are `null` at the ends of the result set; `first` and `last` are always present.
    - `first` string, required — The url of the first page for the paginated results set
    - `next` string, nullable, required — The url of the next page for the paginated results set
    - `prev` string, nullable, required — The url of the previous page for the paginated results set
    - `last` string, required — The url of the last page for the paginated results set

## Other responses

- `401` — The user is unauthenticated

---

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