---
title: "List coupons (API token)"
method: POST
path: "/api/v1/me/coupons"
tags: ["Affiliate"]
---

# List coupons (API token)

`POST /api/v1/me/coupons`

## Request

- Base URL: `https://api.feedico.io`
- URL: `https://api.feedico.io/api/v1/me/coupons`
- Auth: HTTP bearer

Paginated coupons; POST JSON. Filter by **`provider`** or substring **`firmName`** (merchant display from linked programme, coupon title, or merchant key).

## Request body

- CustomerDataListRequest
  - `page` integer: 1-based page index.
  - `pageSize` integer: Items per page (max 200).
  - `provider` string, nullable: Filter by integration id (matches values in response `availableProviders`).
  - `firmName` string, nullable: Substring filter on merchant display name (networks); on coupons - linked programme display name, title, or external merchant key.

## Response `200`

Coupon page

- CouponListResponse
  - `ok` boolean, required
  - `recordCount` integer, required: Total rows matching filters.
  - `page` integer, required
  - `pageSize` integer, required
  - `availableProviders` string[], required: Distinct integration keys in your coupon rows.
  - `coupons` CouponRow[], required
    - `id` string
    - `networkId` string
    - `provider` string
    - `externalMerchantKey` string
    - `externalCouponId` string
    - `code` string, nullable
    - `title` string, nullable
    - `description` string, nullable
    - `startsAt` string, nullable
    - `endsAt` string, nullable
    - `offerUrl` string, nullable
    - `extra` unknown
    - `fetchedAt` string, nullable

## Other responses

- `401`: Missing or invalid bearer token
- `503`: Database or schema unavailable

---

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