DocsAPI ReferenceVoucher/bff/voucher/analyze
getVoucherAdmin BFF

/bff/voucher/analyze

Returns a lightweight snapshot of a voucher: whether it exists in the organisation and, if it does, its computed status (active / inactive / expired / not-yet-valid / limit-reached). Unlike /full-detail, this endpoint does NOT throw when the voucher is missing.

VouchergetBffVoucherAnalyze

Parameters

1 query

1 total
Query · 1
codestringRequired

Voucher code to analyze.

Request

GET /bff/voucher/analyze

get
curl -X GET "https://api.bizkithub.com/bff/voucher/analyze?code=SUMMER2024" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

Voucher analysis result.

{
  "exists": false
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key