---
title: "Subscribers"
method: GET
path: "/api/admin/mailing/subscribers"
tags: ["mailing"]
---

# Subscribers

`GET /api/admin/mailing/subscribers`

## Request

- Base URL: `https://api.getcheapgames.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.getcheapgames.com/api/admin/mailing/subscribers`
- Auth: none declared

One page of the list, newest signup first unless sorted otherwise, each
row with that list's emails to it (`alertsSent`, `lastAlertAt`).

`q` is a case-insensitive piece of the address, matched literally: `_`
and `%` are characters here, not wildcards. `counts` is per status for
the same search, for the filter chips.

## Query parameters

- `q` string
- `status` 'all' | 'subscribed' | 'pending' | 'unsubscribed'
- `limit` integer
- `offset` integer
- `sort` string
- `dir` 'asc' | 'desc'
- `list` 'giveaways' | 'sales' | 'news'

## Headers

- `authorization` string

## Response `200`

Successful Response

- SubscribersOut
  - `items` SubscriberOut[], required
    - `id` integer, required
    - `email` string, required
    - `status` string, required
    - `source` string, required
    - `createdAt` string, date-time, required
    - `confirmedAt` string, date-time, nullable, required
    - `unsubscribedAt` string, date-time, nullable, required
    - `accountSub` string, nullable
    - `alertsSent` integer, required
    - `lastAlertAt` string, date-time, nullable, required
  - `total` integer, required
  - `limit` integer, required
  - `offset` integer, required
  - `counts` TabCounts, required: Per status, for the same search: what each filter chip would show.
    - `all` integer, required
    - `subscribed` integer, required
    - `pending` integer, required
    - `unsubscribed` integer, required
  - `listId` 'giveaways' | 'sales' | 'news', required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/getcheapgames/apis/getcheapgames-api.md) · [All operations](https://skmtc.dev/getcheapgames/apis/getcheapgames-api/llms.txt) · [OpenAPI document](https://skmtc.dev/getcheapgames/apis/getcheapgames-api/revisions/57333a690301?raw)