Skip to main content
The Developer API authenticates every request via the X-API-Key header. There are no OAuth flows, bearer tokens, or session cookies on this surface.

​
Creating an API key

  1. Sign in to VoucherGrid.
  2. Open Developer → API keys.
  3. Click Create key, choose the scopes you need, and copy the full key value. The full key is shown once – store it in a secret manager immediately.

​
Key format

API keys are issued in two formats: The first 12 characters (the prefix) appear in the dashboard for identification – the rest of the key is never recoverable after creation.

​
Sending the key

Include the key in the X-API-Key header on every request:

​
Authentication failures

​
Tenant scoping

Every API key belongs to exactly one tenant. All reads and writes performed via the key are automatically scoped to that tenant – you cannot read or modify another tenant’s data, and there is no tenant ID parameter to override.

​
Location-scoped keys

A key may optionally be scoped to a single location. When that is the case:
  • Voucher list/get/redeem operations only see vouchers at that location.
  • Voucher creation forces the new voucher to that location. Passing a different location_id in the request body returns 403 Forbidden.