Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB
OAuth

Generate OAuth 2.0 Token

Generate an OAuth 2.0 token for an API client. The token can be used to authorize access to the Voucherify API. The token inherits the permissions and IP whitelists of the API key that is used to generate the OAuth token. You can define the scope that limits its usage. You can generate up to 1000 OAuth tokens per project. The token expires in 900 seconds (15 minutes).

If the API key that is used to generate the OAuth token is deleted or blocked, you cannot generate new OAuth tokens and the existing ones will stop working within one minute.

If the API key used to generate an OAuth token is regenerated, the OAuth token can still be used.

🚧 Format of scope values

Separate the values of the scope property with spaces.

post/v1/oauth/token

Response

Returns details about the token to be used and its expiration times.

access_tokenstring

The access token used to authorize access to the Voucherify API.

client_idstring

Unique client identifier, assigned by Voucherify, for OAuth.

expires_atinteger

Timestamp in seconds in the Unix format indicating when the token expires.

expires_ininteger

Number of seconds left until the token expires.

scopestring

Defines the scope of possible actions that can be done with the OAuth token. The api scope allows using the server-side API. The client_api scope allows using the whole client-side API. Possible values: api, assets, async-actions, campaigns, categories, client_api, client_consents, client_customers, client_events, client_promotions, client_publish, client_qualifications, client_redeem, client_redemptions, client_validate, client_validations, client_vouchers, consents, customers, events, exports, locations, loyalties, metadata-schemas, orders, product-collections, products, promotions, publications, qualifications, redemptions, referrals, rewards, segments, skus, task-results, templates, trash-bin, validation-rules-assignments, validation-rules, validations, vouchers.

token_type'Bearer'

Type of the token. Use the value as the header prefix for authorization.