List catalog vouchers
curl --request GET \
--url https://app.giftvoucherbrilliance.co.uk/api/external/v1/tenants/{tenant}/catalog/vouchers \
--header 'Accept: <accept>' \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Accept: '<accept>', Authorization: 'Bearer <token>'}};
fetch('https://app.giftvoucherbrilliance.co.uk/api/external/v1/tenants/{tenant}/catalog/vouchers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.giftvoucherbrilliance.co.uk/api/external/v1/tenants/{tenant}/catalog/vouchers"
headers = {
"Accept": "<accept>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.giftvoucherbrilliance.co.uk/api/external/v1/tenants/{tenant}/catalog/vouchers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Accept: <accept>",
"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": 123,
"slug": "<string>",
"title": "<string>",
"currency": "<string>",
"is_monetary": true,
"allow_part_redeem": true,
"sort_order": 123,
"image_urls": [
"<string>"
],
"category_refs": [
{
"id": 123,
"slug": "<string>",
"title": "<string>",
"sort_order": 123
}
],
"variant_summaries": [
{
"id": 123,
"slug": "<string>",
"title": "<string>",
"price": 123,
"sale_price": 123,
"currency": "<string>",
"is_monetary": true,
"sort_order": 123,
"updated_at": "2023-11-07T05:31:56Z"
}
],
"updated_at": "2023-11-07T05:31:56Z",
"summary": "<string>",
"description_html": "<string>",
"price": 123,
"sale_price": 123,
"from_price": 123,
"from_sale_price": 123,
"monetary_value": 123,
"validity_type": "<string>",
"validity_months": 123,
"redemption_info": "<string>",
"image_url": "<string>",
"categories": [
{
"id": 123,
"slug": "<string>",
"title": "<string>",
"sort_order": 123
}
],
"variants": [
{
"id": 123,
"slug": "<string>",
"title": "<string>",
"price": 123,
"sale_price": 123,
"currency": "<string>",
"is_monetary": true,
"sort_order": 123,
"updated_at": "2023-11-07T05:31:56Z"
}
]
}
],
"next_cursor": "<string>",
"server_time": "2023-11-07T05:31:56Z"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}{
"message": "<string>"
}Catalog
List catalog vouchers
view_vouchers permission required.
All successful responses include X-Request-Id and Cache-Control: private, no-store. Requests are limited to 120 per minute.
GET
/
tenants
/
{tenant}
/
catalog
/
vouchers
List catalog vouchers
curl --request GET \
--url https://app.giftvoucherbrilliance.co.uk/api/external/v1/tenants/{tenant}/catalog/vouchers \
--header 'Accept: <accept>' \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Accept: '<accept>', Authorization: 'Bearer <token>'}};
fetch('https://app.giftvoucherbrilliance.co.uk/api/external/v1/tenants/{tenant}/catalog/vouchers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.giftvoucherbrilliance.co.uk/api/external/v1/tenants/{tenant}/catalog/vouchers"
headers = {
"Accept": "<accept>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.giftvoucherbrilliance.co.uk/api/external/v1/tenants/{tenant}/catalog/vouchers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Accept: <accept>",
"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": 123,
"slug": "<string>",
"title": "<string>",
"currency": "<string>",
"is_monetary": true,
"allow_part_redeem": true,
"sort_order": 123,
"image_urls": [
"<string>"
],
"category_refs": [
{
"id": 123,
"slug": "<string>",
"title": "<string>",
"sort_order": 123
}
],
"variant_summaries": [
{
"id": 123,
"slug": "<string>",
"title": "<string>",
"price": 123,
"sale_price": 123,
"currency": "<string>",
"is_monetary": true,
"sort_order": 123,
"updated_at": "2023-11-07T05:31:56Z"
}
],
"updated_at": "2023-11-07T05:31:56Z",
"summary": "<string>",
"description_html": "<string>",
"price": 123,
"sale_price": 123,
"from_price": 123,
"from_sale_price": 123,
"monetary_value": 123,
"validity_type": "<string>",
"validity_months": 123,
"redemption_info": "<string>",
"image_url": "<string>",
"categories": [
{
"id": 123,
"slug": "<string>",
"title": "<string>",
"sort_order": 123
}
],
"variants": [
{
"id": 123,
"slug": "<string>",
"title": "<string>",
"price": 123,
"sale_price": 123,
"currency": "<string>",
"is_monetary": true,
"sort_order": 123,
"updated_at": "2023-11-07T05:31:56Z"
}
]
}
],
"next_cursor": "<string>",
"server_time": "2023-11-07T05:31:56Z"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}{
"message": "<string>"
}Authorizations
Bearer token created in the GVB API Access page.
Headers
Must be application/json.
Available options:
application/json Path Parameters
Authorised tenant identifier from the tenant directory.
Query Parameters
Return records updated at or after this ISO-8601 timestamp.
Opaque cursor from next_cursor; do not inspect or modify it. Page size is fixed at 50.
Comma-separated related resources: categories, variants.
⌘I