# View voucher details
- Operation ID: `ViewVoucherDetails`
- HTTP method: `GET`
- Path: `/v4/vouchers/item/{voucherUuid}`
- [Human-readable API reference](https://hub.synerise.com/api-reference/loyalty-and-engagement#tag/Vouchers/operation/ViewVoucherDetails)
## Self-contained OpenAPI method
The fenced document below contains this method's documentation and all of its local references. It is self-contained; no category or master specification fetch is required.
```yaml
openapi: 3.0.0
info:
title: Synerise Public API
version: 1.9.1
paths:
/v4/vouchers/item/{voucherUuid}:
get:
tags:
- Vouchers
summary: View voucher details
description: |
Retrieve all details of a single code.
---
**API consumers:** Workspace (Business Profile), Synerise User
**API key permission required:** `VOUCHERS_ITEM_READ`
**User role permission required:** `assets_code_pool: read`
operationId: ViewVoucherDetails
parameters:
- name: voucherUuid
in: path
description: UUID of the voucher
required: true
schema:
type: string
example: 29392878-d43f-402e-8297-f63d465cf173
- name: Accept
in: header
required: true
style: simple
explode: false
schema:
type: string
enum:
- application/json
- name: Content-Type
in: header
required: true
style: simple
explode: false
schema:
type: string
enum:
- application/json
- name: Api-Version
in: header
required: true
style: simple
explode: false
schema:
type: string
enum:
- "4.4"
- "4.2"
responses:
"200":
description: Details of a voucher
content:
application/json:
schema:
type: object
properties:
data:
required:
- poolUuid
type: object
properties:
poolUuid:
type: string
description: UUID of the voucher pool
example: faec32b0-c343-4362-ba32-c6148c649da4
clientUuid:
type: string
description: UUID of the Profile
example: 07243772-008a-42e1-ba37-c3807cebde8f
clientId:
type: integer
description: ID of the Profile
code:
type: string
description: |
Voucher code
Must match the pattern: `^.{0,36}$`
example: code123
nullable: true
expireIn:
type: string
format: date-time
description: Date when the voucher expires.
nullable: true
redeemAt:
type: string
format: date-time
description: Time when the voucher was redeemed. Defaults to current time when redeeming.
nullable: true
assignedAt:
type: string
format: date-time
description: Time when the voucher was assigned. Defaults to current time when assigning.
nullable: true
status:
type: string
description: Voucher status
enum:
- ASSIGNED
- UNASSIGNED
- REDEEMED
- CANCELED
example: ASSIGNED
createdAt:
type: string
format: date-time
description: Time when the voucher was created.
updatedAt:
type: string
format: date-time
description: Time when the voucher was last updated.
deprecated: false
security:
- JWT: []
x-snr-doc-urls:
- /api-reference/loyalty-and-engagement#tag/Vouchers/operation/ViewVoucherDetails
x-codeSamples:
- lang: cURL
label: cURL
source: |-
curl --request GET \
--url https://api.synerise.com/v4/vouchers/item/29392878-d43f-402e-8297-f63d465cf173 \
--header 'Accept: SOME_STRING_VALUE' \
--header 'Api-Version: SOME_STRING_VALUE' \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
--header 'Content-Type: SOME_STRING_VALUE'
- lang: Python
label: Python
source: |-
import http.client
conn = http.client.HTTPSConnection("api.synerise.com")
headers = {
'Accept': "SOME_STRING_VALUE",
'Content-Type': "SOME_STRING_VALUE",
'Api-Version': "SOME_STRING_VALUE",
'Authorization': "Bearer REPLACE_BEARER_TOKEN"
}
conn.request("GET", "/v4/vouchers/item/29392878-d43f-402e-8297-f63d465cf173", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
- lang: JavaScript
label: JavaScript
source: |-
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://api.synerise.com/v4/vouchers/item/29392878-d43f-402e-8297-f63d465cf173");
xhr.setRequestHeader("Accept", "SOME_STRING_VALUE");
xhr.setRequestHeader("Content-Type", "SOME_STRING_VALUE");
xhr.setRequestHeader("Api-Version", "SOME_STRING_VALUE");
xhr.setRequestHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
xhr.send(data);
- lang: Node.js
label: Node.js
source: |-
const http = require("https");
const options = {
"method": "GET",
"hostname": "api.synerise.com",
"port": null,
"path": "/v4/vouchers/item/29392878-d43f-402e-8297-f63d465cf173",
"headers": {
"Accept": "SOME_STRING_VALUE",
"Content-Type": "SOME_STRING_VALUE",
"Api-Version": "SOME_STRING_VALUE",
"Authorization": "Bearer REPLACE_BEARER_TOKEN"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
- lang: PHP
label: PHP
source: |-
setUrl('https://api.synerise.com/v4/vouchers/item/29392878-d43f-402e-8297-f63d465cf173');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders([
'Accept' => 'SOME_STRING_VALUE',
'Content-Type' => 'SOME_STRING_VALUE',
'Api-Version' => 'SOME_STRING_VALUE',
'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
- lang: Java
label: Java
source: |-
HttpResponse response = Unirest.get("https://api.synerise.com/v4/vouchers/item/29392878-d43f-402e-8297-f63d465cf173")
.header("Accept", "SOME_STRING_VALUE")
.header("Content-Type", "SOME_STRING_VALUE")
.header("Api-Version", "SOME_STRING_VALUE")
.header("Authorization", "Bearer REPLACE_BEARER_TOKEN")
.asString();
servers:
- description: Microsoft Azure EU
url: https://api.synerise.com
- description: Microsoft Azure USA
url: https://api.azu.synerise.com
- description: Google Cloud Platform
url: https://api.geb.synerise.com
tags:
- name: Vouchers
components:
securitySchemes:
JWT:
type: http
scheme: bearer
description: |-
JWT Bearer token. The header looks like this: `Bearer {JWT}`
Remember to include the space between 'Bearer' and the token.
Generate a token via the **Authorization** endpoints.
```