Get voucher for a contact

api-keystring

The API key should be passed in the request headers as api-key for authentication.

pidstringRequiredformat: "uuid"

Loyalty Program ID

limitintegerOptional1-100Defaults to 25

Page size

offsetintegerOptionalDefaults to 0

Pagination offset

sortenumOptionalDefaults to desc

Sort order

Allowed values:

sortFieldenumOptionalDefaults to updatedAt

Sort field

Allowed values:

contactIdintegerRequired>=1

Contact ID

metadata_key_valuestringOptional

Metadata value for a Key filter

rewardIdstringOptional

Reward ID

Voucher list successfully retrieved

contactIdlong

Contact id associated with the current reward

contactRewardslist of objects

List of all the rewards for current contact

countinteger

Count of the rewards associated with the current contact

loyaltyProgramIdstring

Loyalty Program Id for the contact

loyaltySubscriptionIdstring

Loyalty Subscription Id for the contact

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error

1	import { BrevoClient } from "@getbrevo/brevo";
2
3	async function main() {
4	const client = new BrevoClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.reward.getVoucherForAContact("pid", {
8	contactId: 1,
9	});
10	}
11	main();

1	{
2	"contactId": 1,
3	"contactRewards": [
4	{
5	"code": "string",
6	"consumedAt": "string",
7	"createdAt": "string",
8	"expirationDate": "string",
9	"id": "string",
10	"meta": {},
11	"rewardId": "string",
12	"unit": "string",
13	"updatedAt": "string",
14	"value": 1.1
15	}
16	],
17	"count": 1,
18	"loyaltyProgramId": "string",
19	"loyaltySubscriptionId": "string"
20	}