List redemption links

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

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

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

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/redemption-links"

	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/redemption-links",
  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": 8017,
        "resource": "redemption-link",
        "token": "ExampleLinkToken000001",
        "url": "https://vouchers.example-transit.example.com/r/ExampleLinkToken000001",
        "name": "Jobticket November - employee 42",
        "mode": "entity-bound",
        "redemptionEntity": {
          "id": 9030,
          "resource": "redemption-entity",
          "refId": "emp-42",
          "_links": {
            "self": {
              "href": "https://api.voucher.allride.io/consumer/v1/redemption-entities/9030",
              "type": "application/json"
            }
          }
        },
        "requireEmailOtp": false,
        "allowedProviderIds": [
          1030,
          1056
        ],
        "allowedVoucherSetIds": [],
        "maxRedemptions": 1,
        "maxTotalRedemptions": null,
        "redemptionCount": 0,
        "metadata": {
          "campaign": "jobticket-nov"
        },
        "expiresAt": "2026-11-30T22:59:59Z",
        "customDomainId": 20030,
        "defaultLocale": "de",
        "status": "active",
        "lastRedeemedAt": null,
        "revokedAt": null,
        "createdBy": {
          "type": "partner-user",
          "id": 4069,
          "label": "[email protected]"
        },
        "createdAt": "2026-10-22T09:00:00Z",
        "updatedAt": "2026-10-22T09:00:00Z",
        "_links": {
          "self": {
            "href": "https://api.voucher.allride.io/consumer/v1/redemption-links/8017",
            "type": "application/json"
          },
          "catalog": {
            "href": "https://api.voucher.allride.io/consumer/v1/redemption-links/8017/catalog",
            "type": "application/json"
          },
          "redemptionEntity": {
            "href": "https://api.voucher.allride.io/consumer/v1/redemption-entities/9030",
            "type": "application/json"
          }
        }
      }
    ],
    "page": 1,
    "perPage": 25,
    "totalPages": 1,
    "total": 1
  }
}

GET

consumer

redemption-links

List redemption links

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

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

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

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/redemption-links"

	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/redemption-links",
  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": 8017,
        "resource": "redemption-link",
        "token": "ExampleLinkToken000001",
        "url": "https://vouchers.example-transit.example.com/r/ExampleLinkToken000001",
        "name": "Jobticket November - employee 42",
        "mode": "entity-bound",
        "redemptionEntity": {
          "id": 9030,
          "resource": "redemption-entity",
          "refId": "emp-42",
          "_links": {
            "self": {
              "href": "https://api.voucher.allride.io/consumer/v1/redemption-entities/9030",
              "type": "application/json"
            }
          }
        },
        "requireEmailOtp": false,
        "allowedProviderIds": [
          1030,
          1056
        ],
        "allowedVoucherSetIds": [],
        "maxRedemptions": 1,
        "maxTotalRedemptions": null,
        "redemptionCount": 0,
        "metadata": {
          "campaign": "jobticket-nov"
        },
        "expiresAt": "2026-11-30T22:59:59Z",
        "customDomainId": 20030,
        "defaultLocale": "de",
        "status": "active",
        "lastRedeemedAt": null,
        "revokedAt": null,
        "createdBy": {
          "type": "partner-user",
          "id": 4069,
          "label": "[email protected]"
        },
        "createdAt": "2026-10-22T09:00:00Z",
        "updatedAt": "2026-10-22T09:00:00Z",
        "_links": {
          "self": {
            "href": "https://api.voucher.allride.io/consumer/v1/redemption-links/8017",
            "type": "application/json"
          },
          "catalog": {
            "href": "https://api.voucher.allride.io/consumer/v1/redemption-links/8017/catalog",
            "type": "application/json"
          },
          "redemptionEntity": {
            "href": "https://api.voucher.allride.io/consumer/v1/redemption-entities/9030",
            "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: createdAt, expiresAt, lastRedeemedAt, name. Default -createdAt. The server appends id as a tie-breaker.

Example:

"-createdAt"

string

Case-insensitive search (at most 255 characters) over name.

Maximum string length: 255

filter[status]

enum<string>

Effective status (equals).

Available options:

active,

exhausted,

expired,

revoked

filter[status][in]

string

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

filter[mode]

enum<string>

Mode (equals).

Available options:

entity-bound,

email-otp,

anonymous

filter[mode][in]

string

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

filter[redemptionEntityId]

integer

Bound entity id (equals).

Required range: x >= 0

filter[redemptionEntityId][in]

string

Bound entity id (one of (comma-separated)). Comma-separated values.

filter[customDomainId]

integer

Custom domain id (equals).

Required range: x >= 0

filter[customDomainId][isNull]

boolean

Custom domain id (is null (true/false)).

filter[token]

string

Exact token (equals).

filter[expiresAt][gte]

string<date-time>

Expiry (greater than or equal).

filter[expiresAt][lt]

string<date-time>

Expiry (less than).

filter[expiresAt][isNull]

boolean

Expiry (is null (true/false)).

filter[createdAt][gt]

string<date-time>

Creation time (download key) (greater than).

filter[createdAt][gte]

string<date-time>

Creation time (download key) (greater than or equal).

filter[createdAt][lt]

string<date-time>

Creation time (download key) (less than).

filter[createdAt][lte]

string<date-time>

Creation time (download key) (less than or equal).

filter[lastRedeemedAt][gte]

string<date-time>

Last redemption (greater than or equal).

filter[lastRedeemedAt][lt]

string<date-time>

Last redemption (less than).

filter[lastRedeemedAt][isNull]

boolean

Last redemption (is null (true/false)).

Response

Page envelope of RedemptionLink items.

data

object

required

The page.

Show child attributes

Consumer API

Workspace API

List redemption links

Authorizations

Query Parameters

Response