# Gift Voucher Brilliance API

## Docs

- [Get a catalog category](https://docs.gvb-staging.co.uk/api-reference/catalog/get-a-catalog-category.md): `view_categories` permission required.
- [Get a catalog voucher](https://docs.gvb-staging.co.uk/api-reference/catalog/get-a-catalog-voucher.md): `view_vouchers` permission required.
- [List catalog categories](https://docs.gvb-staging.co.uk/api-reference/catalog/list-catalog-categories.md): `view_categories` permission required.
- [List catalog vouchers](https://docs.gvb-staging.co.uk/api-reference/catalog/list-catalog-vouchers.md): `view_vouchers` permission required.
- [Get a marketing signup](https://docs.gvb-staging.co.uk/api-reference/customers/get-a-marketing-signup.md): `export_customer_information` permission required.
- [List marketing signups](https://docs.gvb-staging.co.uk/api-reference/customers/list-marketing-signups.md): `export_customer_information` permission required.
- [Redeem a voucher](https://docs.gvb-staging.co.uk/api-reference/redemptions/redeem-a-voucher.md): `redeem_vouchers` permission required. This operation changes voucher state.
- [Resolve a voucher for redemption](https://docs.gvb-staging.co.uk/api-reference/redemptions/resolve-a-voucher-for-redemption.md): `redeem_vouchers` permission required. This validation step does not redeem the voucher.
- [Get a purchased voucher](https://docs.gvb-staging.co.uk/api-reference/sales/get-a-purchased-voucher.md): `view_vouchers` and `view_orders` permissions required.
- [List purchased vouchers](https://docs.gvb-staging.co.uk/api-reference/sales/list-purchased-vouchers.md): `view_vouchers` and `view_orders` permissions required.
- [List available tenants](https://docs.gvb-staging.co.uk/api-reference/tenants/list-available-tenants.md): No additional permission.
- [Changelog](https://docs.gvb-staging.co.uk/changelog.md): Public changes to the external API and documentation.
- [Authentication](https://docs.gvb-staging.co.uk/guides/authentication.md): Obtain and protect bearer tokens.
- [Catalog synchronization](https://docs.gvb-staging.co.uk/guides/catalog-sync.md): Import vouchers and categories incrementally.
- [Customer exports](https://docs.gvb-staging.co.uk/guides/customer-exports.md): Export opted-in marketing contacts responsibly.
- [Money, dates, and identifiers](https://docs.gvb-staging.co.uk/guides/data-types.md): Interpret API values without losing precision.
- [Errors, rate limits, and request IDs](https://docs.gvb-staging.co.uk/guides/errors-rate-limits.md): Recover safely and give support useful context.
- [Includes](https://docs.gvb-staging.co.uk/guides/includes.md): Request supported related data without extra calls.
- [Pagination and incremental sync](https://docs.gvb-staging.co.uk/guides/pagination-sync.md): Build reliable cursor-based synchronisation.
- [Purchased-voucher synchronization](https://docs.gvb-staging.co.uk/guides/purchased-voucher-sync.md): Import sales vouchers and current balances.
- [Voucher redemption workflow](https://docs.gvb-staging.co.uk/guides/redemptions.md): Resolve first, then redeem deliberately.
- [Security practices](https://docs.gvb-staging.co.uk/guides/security.md): Operate an integration with least privilege.
- [Tenants and permissions](https://docs.gvb-staging.co.uk/guides/tenants-permissions.md): Select tenant context and request the minimum access.
- [Troubleshooting](https://docs.gvb-staging.co.uk/guides/troubleshooting.md): Diagnose common integration failures.
- [External API](https://docs.gvb-staging.co.uk/index.md): Build secure integrations with Gift Voucher Brilliance.
- [Quickstart](https://docs.gvb-staging.co.uk/quickstart.md): Make your first authenticated request safely.
- [Support](https://docs.gvb-staging.co.uk/support.md): Get help with an API integration.
- [Versioning policy](https://docs.gvb-staging.co.uk/versioning.md): How external API compatibility is managed.

## OpenAPI Specs

- [openapi](https://docs.gvb-staging.co.uk/openapi.json)