---
title: "Giveaways"
method: GET
path: "/api/admin/mailing/giveaways"
tags: ["mailing"]
---

# Giveaways

`GET /api/admin/mailing/giveaways`

## 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/giveaways`
- Auth: none declared

One page of the free games, newest giveaway first unless sorted otherwise:
one row per game per store, so a game free on Steam and on the Epic Games
Store at once is two rows.

`q` is a case-insensitive piece of the title (the store's, else the
game's), matched literally as on the subscribers. `counts` is per status
and per store for the same search; see `GiveawayCounts`.

## Query parameters

- `q` string
- `status` 'open' | 'ended' | 'all'
- `platform` 'all' | 'steam' | 'epic' | 'gog'
- `limit` integer
- `offset` integer
- `sort` string
- `dir` 'asc' | 'desc'

## Headers

- `authorization` string

## Response `200`

Successful Response

- GcgRoutersMailingGiveawaysOut
  - `items` GcgRoutersMailingGiveawayOut[], required
    - `id` integer, required
    - `gameId` integer, required
    - `title` string, required
    - `platform` string, required
    - `claimUrl` string, nullable, required
    - `startedAt` string, date-time, required
    - `endsAt` string, date-time, nullable, required
    - `endedAt` string, date-time, nullable, required
    - `alertsSent` integer, required
    - `sourceId` string, nullable, required
  - `total` integer, required
  - `limit` integer, required
  - `offset` integer, required
  - `counts` GiveawayCounts, required: What each chip would show, for the same search. Each row of chips is counted under the OTHER row's choice: the status chips on the store chosen, the store chips in the status chosen; so the chip that is lit always reads the table's `total`.
    - `open` integer, required
    - `ended` integer, required
    - `all` integer, required
    - `byPlatform` PlatformCounts, required
      - `steam` integer, required
      - `epic` integer, required
      - `gog` integer, 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)