List catalog voucher sets

curl --request GET \
  --url https://api.voucher-staging.allride.io/consumer/v1/catalog/voucher-sets \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.voucher-staging.allride.io/consumer/v1/catalog/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/consumer/v1/catalog/voucher-sets"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.voucher-staging.allride.io/consumer/v1/catalog/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/consumer/v1/catalog/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": "consumer-catalog-entry",
        "providerPartnerId": 1030,
        "provider": {
          "id": 1030,
          "resource": "consumer-catalog-provider",
          "slug": "acme-scooters",
          "displayName": {
            "de": "Acme Scooters",
            "en": "Acme Scooters"
          },
          "logoUrl": "https://assets.voucher.allride.io/acme-scooters/3095.png",
          "_links": {
            "self": {
              "href": "https://api.voucher.allride.io/consumer/v1/catalog/providers/1030",
              "type": "application/json"
            }
          }
        },
        "voucherKind": "code",
        "availability": "active",
        "activeFrom": "2026-10-01T00:00:00Z",
        "deactivateAt": null,
        "revisionNo": 2,
        "revisionApprovedAt": "2026-09-28T09:40:11Z",
        "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
        },
        "brandingOverrideAssetUrls": null,
        "stockStatus": "available",
        "providerToggle": true,
        "voucherSetToggle": true,
        "position": 1,
        "featured": true,
        "effectiveCategoryId": 7017,
        "priceAcceptance": {
          "status": "accepted",
          "nextChangeAt": null
        },
        "setting": {
          "enabled": true,
          "position": null,
          "featured": false,
          "categoryOverrideId": null,
          "entityLimit": {
            "max": 1,
            "period": "calendar-month"
          },
          "settings": null,
          "externalRef": "3",
          "updatedAt": "2026-10-20T10:02:00Z"
        },
        "_links": {
          "self": {
            "href": "https://api.voucher.allride.io/consumer/v1/catalog/voucher-sets/2030",
            "type": "application/json"
          },
          "provider": {
            "href": "https://api.voucher.allride.io/consumer/v1/catalog/providers/1030",
            "type": "application/json"
          }
        }
      }
    ],
    "page": 1,
    "perPage": 25,
    "totalPages": 1,
    "total": 1
  }
}

Catalog

List catalog voucher sets

Lists the voucher sets visible to you: an approved live revision, effective status scheduled, active or deactivation-scheduled, an active provider, and access granted by AllRide. Entries are returned whatever your toggles say; apps and landing pages use filter[providerToggle]=true&filter[voucherSetToggle]=true and show only entries whose priceAcceptance.status is accepted, change-pending or exempt. Stock is shown only as stockStatus. Cache for at most 60 seconds and refresh on catalog-* webhooks. See Catalog and toggles.

Required permissions: view-consumer-catalog · API keys: allowed

GET

consumer

catalog

voucher-sets

List catalog voucher sets

curl --request GET \
  --url https://api.voucher-staging.allride.io/consumer/v1/catalog/voucher-sets \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.voucher-staging.allride.io/consumer/v1/catalog/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/consumer/v1/catalog/voucher-sets"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.voucher-staging.allride.io/consumer/v1/catalog/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/consumer/v1/catalog/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": "consumer-catalog-entry",
        "providerPartnerId": 1030,
        "provider": {
          "id": 1030,
          "resource": "consumer-catalog-provider",
          "slug": "acme-scooters",
          "displayName": {
            "de": "Acme Scooters",
            "en": "Acme Scooters"
          },
          "logoUrl": "https://assets.voucher.allride.io/acme-scooters/3095.png",
          "_links": {
            "self": {
              "href": "https://api.voucher.allride.io/consumer/v1/catalog/providers/1030",
              "type": "application/json"
            }
          }
        },
        "voucherKind": "code",
        "availability": "active",
        "activeFrom": "2026-10-01T00:00:00Z",
        "deactivateAt": null,
        "revisionNo": 2,
        "revisionApprovedAt": "2026-09-28T09:40:11Z",
        "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
        },
        "brandingOverrideAssetUrls": null,
        "stockStatus": "available",
        "providerToggle": true,
        "voucherSetToggle": true,
        "position": 1,
        "featured": true,
        "effectiveCategoryId": 7017,
        "priceAcceptance": {
          "status": "accepted",
          "nextChangeAt": null
        },
        "setting": {
          "enabled": true,
          "position": null,
          "featured": false,
          "categoryOverrideId": null,
          "entityLimit": {
            "max": 1,
            "period": "calendar-month"
          },
          "settings": null,
          "externalRef": "3",
          "updatedAt": "2026-10-20T10:02:00Z"
        },
        "_links": {
          "self": {
            "href": "https://api.voucher.allride.io/consumer/v1/catalog/voucher-sets/2030",
            "type": "application/json"
          },
          "provider": {
            "href": "https://api.voucher.allride.io/consumer/v1/catalog/providers/1030",
            "type": "application/json"
          }
        }
      }
    ],
    "page": 1,
    "perPage": 25,
    "totalPages": 1,
    "total": 1
  }
}

Authorizations

Authorization

string

header

required

Your API key in Authorization: Bearer <key>. Use vk_test_… keys against the sandbox and vk_live_… keys against production.

Query Parameters

page

integer

default:1

Page number, 1-100,000 (default 1). Outside the range: 400 data-failed-validation with the constraint invalid-page.

Required range: 1 <= x <= 100000

perPage

integer

default:25

Items per page, 1-100 (default 25). Outside the range: 400 data-failed-validation with the constraint invalid-page.

Required range: 1 <= x <= 100

sort

string

One sort field; prefix - for descending (sort=field or sort=-field). Allowed: position, activeFrom, deactivateAt, revisionApprovedAt. Default position. The server appends id as a tie-breaker.

Example:

"position"

string

Case-insensitive search (at most 255 characters) over live.name, live.summary, live.valueLabel.

Maximum string length: 255

filter[providerPartnerId]

integer

Provider id (equals).

Required range: x >= 0

filter[providerPartnerId][in]

string

Provider id (one of (comma-separated)). Comma-separated values.

filter[availability]

enum<string>

Availability (equals).

Available options:

upcoming,

active,

deactivation-scheduled

filter[availability][in]

string

Availability (one of (comma-separated)). Comma-separated values.

filter[voucherKind]

enum<string>

Voucher kind (equals).

Available options:

code,

link

filter[effectiveCategoryId]

integer

Effective category id (equals).

Required range: x >= 0

filter[effectiveCategoryId][in]

string

Effective category id (one of (comma-separated)). Comma-separated values.

filter[stockStatus]

enum<string>

Stock status (equals).

Available options:

available,

low,

depleted

filter[stockStatus][in]

string

Stock status (one of (comma-separated)). Comma-separated values.

filter[providerToggle]

boolean

Your Provider Toggle (equals).

filter[voucherSetToggle]

boolean

Your Voucher Set Toggle (equals).

filter[featured]

boolean

Featured (equals).

filter[setting.externalRef]

string

Your external reference (equals).

filter[setting.externalRef][in]

string

Your external reference (one of (comma-separated)). Comma-separated values.

filter[activeFrom][gte]

string<date-time>

Activation time (greater than or equal).

filter[activeFrom][lt]

string<date-time>

Activation time (less than).

filter[activeFrom][isNull]

boolean

Activation time (is null (true/false)).

filter[deactivateAt][gte]

string<date-time>

Deactivation time (greater than or equal).

filter[deactivateAt][lt]

string<date-time>

Deactivation time (less than).

filter[deactivateAt][isNull]

boolean

Deactivation time (is null (true/false)).

Response

Page envelope of ConsumerCatalogEntry items.

data

object

required

The page.

Show child attributes

Consumer API

Workspace API

List catalog voucher sets

Authorizations

Query Parameters

Response