Get a catalog provider
curl --request GET \
--url https://api.voucher-staging.allride.io/consumer/v1/catalog/providers/{providerId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.voucher-staging.allride.io/consumer/v1/catalog/providers/{providerId}', 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/providers/{providerId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)HttpResponse<String> response = Unirest.get("https://api.voucher-staging.allride.io/consumer/v1/catalog/providers/{providerId}")
.header("Authorization", "Bearer <token>")
.asString();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.voucher-staging.allride.io/consumer/v1/catalog/providers/{providerId}"
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/providers/{providerId}",
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": {
"id": 1030,
"resource": "consumer-catalog-provider",
"slug": "acme-scooters",
"availability": "active",
"voucherSetCounts": {
"upcoming": 1,
"active": 1,
"deactivationScheduled": 0
},
"nextActiveFrom": "2026-11-01T00:00:00Z",
"earliestDeactivateAt": null,
"profile": {
"displayName": {
"de": "Acme Scooters",
"en": "Acme Scooters"
},
"tagline": {
"de": "E-Scooter und E-Bikes",
"en": "E-scooters and e-bikes"
},
"description": null,
"termsText": null,
"termsUrl": "https://acme-scooters.example.com/terms",
"privacyUrl": "https://acme-scooters.example.com/privacy",
"websiteUrl": "https://acme-scooters.example.com",
"supportUrl": null,
"appLinks": {
"appStoreUrl": "https://apps.apple.com/app/id0000000001",
"playStoreUrl": null
},
"defaultCategoryId": 7017,
"countries": [
"DE"
]
},
"profileRevisionNo": 2,
"listingBranding": {
"primaryColor": "#14d0e8",
"secondaryColor": null,
"backgroundColor": "#0b1f33",
"surfaceColor": null,
"textColor": "#ffffff",
"accentColor": null,
"buttonColor": "#14d0e8",
"buttonTextColor": "#0b1f33",
"buttonBorderColor": null,
"logoAssetId": 3095,
"logoDarkAssetId": null,
"iconAssetId": null,
"heroImageAssetId": null,
"faviconAssetId": null,
"emailLogoAssetId": null,
"fontFamily": "inter",
"cornerRadius": "md",
"extensions": null,
"assetUrls": {
"logo": {
"assetId": 3095,
"url": "https://assets.voucher.allride.io/acme-scooters/3095.png",
"width": 320,
"height": 80,
"variants": null
},
"logoDark": null,
"icon": null,
"hero": null
}
},
"providerToggle": true,
"featured": true,
"effectiveCategoryId": 7017,
"setting": {
"enabled": true,
"autoEnableNewVoucherSets": true,
"position": 1,
"featured": true,
"categoryOverrideId": null,
"settings": {
"schemaVersion": 1,
"minClientVersion": "3.0.24"
},
"externalRef": "3",
"updatedAt": "2026-10-20T10:00:00Z"
},
"_links": {
"self": {
"href": "https://api.voucher.allride.io/consumer/v1/catalog/providers/1030",
"type": "application/json"
}
}
}
}
Catalog
Get a catalog provider
Returns one catalog provider with your setting. A provider without a voucher set visible to you answers 404 provider-not-found. See Catalog and toggles.
Required permissions: view-consumer-catalog · API keys: allowed
GET
/
consumer
/
v1
/
catalog
/
providers
/
{providerId}
Get a catalog provider
curl --request GET \
--url https://api.voucher-staging.allride.io/consumer/v1/catalog/providers/{providerId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.voucher-staging.allride.io/consumer/v1/catalog/providers/{providerId}', 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/providers/{providerId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)HttpResponse<String> response = Unirest.get("https://api.voucher-staging.allride.io/consumer/v1/catalog/providers/{providerId}")
.header("Authorization", "Bearer <token>")
.asString();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.voucher-staging.allride.io/consumer/v1/catalog/providers/{providerId}"
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/providers/{providerId}",
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": {
"id": 1030,
"resource": "consumer-catalog-provider",
"slug": "acme-scooters",
"availability": "active",
"voucherSetCounts": {
"upcoming": 1,
"active": 1,
"deactivationScheduled": 0
},
"nextActiveFrom": "2026-11-01T00:00:00Z",
"earliestDeactivateAt": null,
"profile": {
"displayName": {
"de": "Acme Scooters",
"en": "Acme Scooters"
},
"tagline": {
"de": "E-Scooter und E-Bikes",
"en": "E-scooters and e-bikes"
},
"description": null,
"termsText": null,
"termsUrl": "https://acme-scooters.example.com/terms",
"privacyUrl": "https://acme-scooters.example.com/privacy",
"websiteUrl": "https://acme-scooters.example.com",
"supportUrl": null,
"appLinks": {
"appStoreUrl": "https://apps.apple.com/app/id0000000001",
"playStoreUrl": null
},
"defaultCategoryId": 7017,
"countries": [
"DE"
]
},
"profileRevisionNo": 2,
"listingBranding": {
"primaryColor": "#14d0e8",
"secondaryColor": null,
"backgroundColor": "#0b1f33",
"surfaceColor": null,
"textColor": "#ffffff",
"accentColor": null,
"buttonColor": "#14d0e8",
"buttonTextColor": "#0b1f33",
"buttonBorderColor": null,
"logoAssetId": 3095,
"logoDarkAssetId": null,
"iconAssetId": null,
"heroImageAssetId": null,
"faviconAssetId": null,
"emailLogoAssetId": null,
"fontFamily": "inter",
"cornerRadius": "md",
"extensions": null,
"assetUrls": {
"logo": {
"assetId": 3095,
"url": "https://assets.voucher.allride.io/acme-scooters/3095.png",
"width": 320,
"height": 80,
"variants": null
},
"logoDark": null,
"icon": null,
"hero": null
}
},
"providerToggle": true,
"featured": true,
"effectiveCategoryId": 7017,
"setting": {
"enabled": true,
"autoEnableNewVoucherSets": true,
"position": 1,
"featured": true,
"categoryOverrideId": null,
"settings": {
"schemaVersion": 1,
"minClientVersion": "3.0.24"
},
"externalRef": "3",
"updatedAt": "2026-10-20T10:00:00Z"
},
"_links": {
"self": {
"href": "https://api.voucher.allride.io/consumer/v1/catalog/providers/1030",
"type": "application/json"
}
}
}
}
Authorizations
Your API key in Authorization: Bearer <key>. Use vk_test_… keys against the sandbox and vk_live_… keys against production.
Path Parameters
Id of the provider partner. Unsigned 64-bit integer (ids and large counters). May exceed 2^53; parse with a BigInt-safe JSON parser in JavaScript.
Required range:
0 <= x <= 18446744073709552000Response
OK
Single-object envelope around a ConsumerCatalogProvider.
A provider with at least one voucher set visible to you, with your setting.
Show child attributes
Show child attributes