---
title: "Get all coupons"
method: GET
path: "/api/rnb/pvt/coupon"
tags: ["Coupons"]
---

# Get all coupons

`GET /api/rnb/pvt/coupon`

Check the new [Promotions onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/promotions-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Promotions and is organized by focusing on the developer's journey.

 Retrieves all coupons from an account.

## Permissions

Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:

| **Product** | **Category** | **Resource** |
| --------------- | ----------------- | ----------------- |
| Rates and Benefits | Promotions | **Manage benefits and rates** |

There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).

>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.

## Headers

- `Content-Type` string, required
- `Accept` string, required

## Response `200`

OK

- object[] — List of coupons.
  - `lastModifiedUtc` string — Date and time of the last update of the coupon in UTC format.
  - `utmSource` string — UTM source code.
  - `utmCampaign` string — UTM campaign code.
  - `couponCode` string — Coupon code.
  - `isArchived` boolean — Defines if the coupon is archived (`true`) or not (`false`).
  - `maxItemsPerClient` integer — Maximum items per client that the coupon can be applied.
  - `expirationIntervalPerUse` string — Coupon expiration interval per use.
  - `maxUsage` integer — Amount of times the coupon can be used.
  - `groupingKey` string — If the coupon was created as a [multiple coupon](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api/#post-/api/rnb/pvt/multiple-coupons) or using [Generate coupons in bulk](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api/#post-/api/rnb/pvt/coupons), this field returns the original `couponCode` informed.

---

[API](https://skmtc.net/vtex/apis/promotions-taxes-api.md) · [All operations](https://skmtc.net/vtex/apis/promotions-taxes-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vtex/promotions-taxes-api/versions/6ad1b4bbb46f/schema)