List voucher sets
curl --request GET \
--url https://api.voucher-staging.allride.io/provider/v1/voucher-sets \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.voucher-staging.allride.io/provider/v1/voucher-sets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.voucher-staging.allride.io/provider/v1/voucher-sets"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)HttpResponse<String> response = Unirest.get("https://api.voucher-staging.allride.io/provider/v1/voucher-sets")
.header("Authorization", "Bearer <token>")
.asString();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.voucher-staging.allride.io/provider/v1/voucher-sets"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.voucher-staging.allride.io/provider/v1/voucher-sets",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": {
"data": [
{
"id": 2030,
"resource": "voucher-set",
"providerPartnerId": 42,
"internalName": "Ride credit EUR 5 - Q4",
"voucherKind": "code",
"status": "scheduled",
"availability": "upcoming",
"liveRevisionId": 22017,
"liveRevisionNo": 2,
"live": {
"name": {
"de": "5 € Fahrguthaben",
"en": "€5 ride credit"
},
"summary": {
"de": "Für alle E-Scooter",
"en": "For all e-scooters"
},
"bullets": [
{
"de": "Einmal einlösbar",
"en": "Single use"
}
],
"description": null,
"howToRedeem": [
{
"de": "App öffnen und Code unter Wallet eingeben",
"en": "Open the app and enter the code under Wallet"
}
],
"termsText": {
"de": "Einmal pro Konto einlösbar.",
"en": "Redeemable once per account."
},
"valueLabel": {
"de": "5 € Rabatt",
"en": "€5 off"
},
"faceValue": {
"value": 500,
"label": "5,00 €"
},
"categoryId": 7017,
"linkTemplate": "https://acme-scooters.example.com/r?c={{code}}",
"allowedLinkHosts": [
"acme-scooters.example.com"
],
"allowedLinkSchemes": [],
"brandingOverride": null,
"countries": [
"DE"
],
"extensions": null,
"metadata": null
},
"draftContent": null,
"pendingChangeRequestId": null,
"activeFrom": "2026-11-01T00:00:00Z",
"deactivateAt": null,
"activatedAt": null,
"deactivatedAt": null,
"suspendedAt": null,
"archivedAt": null,
"suspensionReason": null,
"stock": {
"remaining": 9950,
"used": 50,
"usagePercent": 0.5,
"availableVoucherCount": 9950,
"expiredVoucherCount": 0,
"revokedVoucherCount": 0,
"stockStatus": "available",
"updatedAt": "2026-10-22T07:58:31.204Z"
},
"createdBy": {
"type": "partner-user",
"id": 4043,
"label": "ops@example.com"
},
"createdAt": "2026-10-20T09:12:44.501Z",
"updatedAt": "2026-10-22T07:10:02.300Z",
"_links": {
"self": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030",
"type": "application/json"
},
"vouchers": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/vouchers",
"type": "application/json"
},
"uploads": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/uploads",
"type": "application/json"
},
"changeRequests": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/change-requests",
"type": "application/json"
},
"changelog": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/changelog",
"type": "application/json"
},
"revisions": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/revisions",
"type": "application/json"
},
"stockAlertRule": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/stock-alert-rule",
"type": "application/json"
}
}
}
],
"page": 1,
"perPage": 25,
"totalPages": 1,
"total": 1
}
}
Voucher sets
List voucher sets
Lists your voucher sets. status filters use the effective status (a scheduled set whose activeFrom has passed is active even before the schedule runs).
Required permissions: view-provider-voucher-sets · API keys: allowed
GET
/
provider
/
v1
/
voucher-sets
List voucher sets
curl --request GET \
--url https://api.voucher-staging.allride.io/provider/v1/voucher-sets \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.voucher-staging.allride.io/provider/v1/voucher-sets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.voucher-staging.allride.io/provider/v1/voucher-sets"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)HttpResponse<String> response = Unirest.get("https://api.voucher-staging.allride.io/provider/v1/voucher-sets")
.header("Authorization", "Bearer <token>")
.asString();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.voucher-staging.allride.io/provider/v1/voucher-sets"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.voucher-staging.allride.io/provider/v1/voucher-sets",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": {
"data": [
{
"id": 2030,
"resource": "voucher-set",
"providerPartnerId": 42,
"internalName": "Ride credit EUR 5 - Q4",
"voucherKind": "code",
"status": "scheduled",
"availability": "upcoming",
"liveRevisionId": 22017,
"liveRevisionNo": 2,
"live": {
"name": {
"de": "5 € Fahrguthaben",
"en": "€5 ride credit"
},
"summary": {
"de": "Für alle E-Scooter",
"en": "For all e-scooters"
},
"bullets": [
{
"de": "Einmal einlösbar",
"en": "Single use"
}
],
"description": null,
"howToRedeem": [
{
"de": "App öffnen und Code unter Wallet eingeben",
"en": "Open the app and enter the code under Wallet"
}
],
"termsText": {
"de": "Einmal pro Konto einlösbar.",
"en": "Redeemable once per account."
},
"valueLabel": {
"de": "5 € Rabatt",
"en": "€5 off"
},
"faceValue": {
"value": 500,
"label": "5,00 €"
},
"categoryId": 7017,
"linkTemplate": "https://acme-scooters.example.com/r?c={{code}}",
"allowedLinkHosts": [
"acme-scooters.example.com"
],
"allowedLinkSchemes": [],
"brandingOverride": null,
"countries": [
"DE"
],
"extensions": null,
"metadata": null
},
"draftContent": null,
"pendingChangeRequestId": null,
"activeFrom": "2026-11-01T00:00:00Z",
"deactivateAt": null,
"activatedAt": null,
"deactivatedAt": null,
"suspendedAt": null,
"archivedAt": null,
"suspensionReason": null,
"stock": {
"remaining": 9950,
"used": 50,
"usagePercent": 0.5,
"availableVoucherCount": 9950,
"expiredVoucherCount": 0,
"revokedVoucherCount": 0,
"stockStatus": "available",
"updatedAt": "2026-10-22T07:58:31.204Z"
},
"createdBy": {
"type": "partner-user",
"id": 4043,
"label": "ops@example.com"
},
"createdAt": "2026-10-20T09:12:44.501Z",
"updatedAt": "2026-10-22T07:10:02.300Z",
"_links": {
"self": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030",
"type": "application/json"
},
"vouchers": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/vouchers",
"type": "application/json"
},
"uploads": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/uploads",
"type": "application/json"
},
"changeRequests": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/change-requests",
"type": "application/json"
},
"changelog": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/changelog",
"type": "application/json"
},
"revisions": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/revisions",
"type": "application/json"
},
"stockAlertRule": {
"href": "https://api.voucher-staging.allride.io/provider/v1/voucher-sets/2030/stock-alert-rule",
"type": "application/json"
}
}
}
],
"page": 1,
"perPage": 25,
"totalPages": 1,
"total": 1
}
}
Authorizations
Partner API key: Authorization: Bearer vk_live_…. Use vk_test_… keys against the sandbox. See Authentication.
Query Parameters
Page number, 1-100,000 (default 1). Outside the range: 400 data-failed-validation with the constraint invalid-page.
Required range:
1 <= x <= 100000Page size 1-100 (default 25). Outside the range: 400 data-failed-validation with the constraint invalid-page.
Required range:
1 <= x <= 100One sort field; prefix - for descending (sort=field or sort=-field); id is appended as tie-breaker. Another value is a 400 data-failed-validation with the constraint invalid-sort. Default -createdAt.
Example:
"-createdAt"
Free-text search over the documented search fields, 1-255 characters.
Maximum string length:
255Up to 100 voucher set ids. Filter on id (one of, comma-separated). Comma-separated values.
Filter on status (equals).
Filter on status (one of, comma-separated). Comma-separated values.
Filter on status (not equal).
Filter on voucherKind (equals).
Filter on categoryId (equals).
Filter on categoryId (one of, comma-separated). Comma-separated values.
Filter on activeFrom (greater than or equal).
Filter on activeFrom (less than).
Filter on activeFrom (is null, true or false).
Filter on deactivateAt (greater than or equal).
Filter on deactivateAt (less than).
Filter on deactivateAt (is null, true or false).
Filter on pendingChangeRequestId (is null, true or false).
Filter on stock.stockStatus (equals).
Filter on stock.stockStatus (one of, comma-separated). Comma-separated values.
Filter on stock.usagePercent (greater than or equal).
Filter on stock.usagePercent (less than or equal).
Filter on createdAt (greater than).
Filter on createdAt (greater than or equal).
Filter on createdAt (less than).
Filter on createdAt (less than or equal).
Response
A page of results.
Page envelope of VoucherSet.
Page body.
Show child attributes
Show child attributes