List gift vouchers
List the studio's gift vouchers, filtered and paginated.
Requires the studio's PRO tier, in addition to the vouchers:read scope.
ApiKeyAuth vouchers:readAuthorizationBearer <shyni_sk_live_*>An API key, issued once and never retrievable again: an organization key in the developer
portal, or a studio key in the studio's admin (Moje studio → API). Send as Authorization: Bearer shyni_sk_live_....
Scope: vouchers:read
state?stringFilter to a single voucher state.
"CREATED""ACTIVE""USED""DEACTIVATED""PAYMENT_TIMEOUT""CANCELLED""REFUNDED"issuedVia?stringFilter to a single issuance channel.
"MANUAL""ONLINE""API""IMPORT"externalRef?stringFilter to a single caller-supplied external reference (exact match).
page?integer1 <= value1perPage?integer1 <= value <= 10020A page of gift vouchers, newest first.
application/json- response
data*array<>meta*curl -X GET 'https://api.shyni.io/api/v1/gift-vouchers' \ -H 'Authorization: Bearer shyni_sk_test_YOUR_KEY'Response 200
A page of gift vouchers, newest first.
{ "data": [ { "id": "string", "code": "string", "value": 0, "remaining": 0, "currency": "string", "state": "CREATED", "issuedVia": "MANUAL", "paidAt": "2019-08-24T14:15:22Z", "validUntil": "2019-08-24", "buyer": { "name": "string", "email": "user@example.com" }, "billing": { "company": "string", "ico": "string", "dic": "string", "address": "string" }, "motif": "CLASSIC", "dedication": "string", "note": "string", "externalRef": "string", "redeemedOrderId": "string", "redeemedAt": "2019-08-24T14:15:22Z", "redemptions": [ { "orderId": "string", "amount": 0, "redeemedAt": "2019-08-24T14:15:22Z" } ], "notification": "SENT", "createdAt": "2019-08-24T14:15:22Z" } ], "meta": { "page": 0, "perPage": 0, "total": 0 }}Response 400
A parameter, header or request body is missing, malformed, or out of range. A request body property the endpoint does not define answers UNKNOWN_FIELD instead, with field naming it.
{ "code": "INVALID_INPUT", "message": "Parameter perPage must be between 1 and 100."}Response 401
Missing, malformed, unknown, or revoked API key (INVALID_API_KEY).
{ "code": "INVALID_API_KEY", "message": "Missing or invalid API key."}Response 403
The key is valid but the request is refused. Branch on code: INSUFFICIENT_SCOPE (the key lacks the
permission this endpoint requires), PLAN_REQUIRED (the studio is not on a plan that includes API keys,
Pro and above), ORIGIN_NOT_ALLOWED, SECRET_KEY_IN_BROWSER, or DEMO_STUDIO on a write to the demo studio.
See Authentication and Scopes above.
{ "code": "INSUFFICIENT_SCOPE", "message": "This API key does not have the permission this endpoint requires."}Response 429
Burst rate limit exceeded.
{ "code": "RATE_LIMITED", "message": "Too many requests. Retry after the time given in the Retry-After header."}