# Vouchers API

> List and retrieve vouchers, including by voucher code.

List and retrieve vouchers, including by voucher code.

Base URL: `https://mpp-api-mybusinessapp-san.azure-api.net/v2`

API version: `3.55.133`

## Endpoints

### GET /vouchers

List vouchers

Returns the vouchers for the tenant identified by the API key. Paginated: use `page`/`limit` or `paginate=false`; filter by team. To count without fetching rows, request `limit=1` and read `metadata.total`. Related: `Retrieve a voucher by code`.

Parameters:

- `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb)
- `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant
- `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID

Reference: https://mybusinessapp.co.za/developers/api/voucher#tag/Voucher/getAllVouchers

### GET /vouchers/vouchercode/{voucherCode}

Retrieve a voucher by code

Returns the voucher with the given `voucherCode`. Related: `List vouchers`.

Parameters:

- `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb)
- `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant
- `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID
- `voucherCode` (path), required — The unique code of the voucher resource

Reference: https://mybusinessapp.co.za/developers/api/voucher#tag/Voucher/getSingleVoucherByVoucherCode

### GET /vouchers/{id}

Retrieve a voucher by id

Returns the voucher with the given `id`. Related: `List vouchers`.

Parameters:

- `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb)
- `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant
- `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID
- `id` (path), required — ID of the voucher resource

Reference: https://mybusinessapp.co.za/developers/api/voucher#tag/Voucher/getSingleVoucher

---

[Rendered page](https://mybusinessapp.co.za/developers/api/voucher)

© MyBusinessApp (Pty) Ltd. Proprietary documentation — do not republish.