For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Help CenterAPI KeysStatusSign In
GuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelog
  • Introduction
    • Getting started
  • Email API
  • Transactional SMS
  • Transactional WhatsApp
  • Marketing Campaigns
  • Contact Management
  • Events
    • GETGet events
    • POSTCreate an event
    • POSTCreate events in batch
  • Object Management
  • Accounts and Settings
  • Sales CRM
  • Conversations
  • Ecommerce
  • Loyalty
      • GETGet code count
      • GETGet voucher for a contact
      • GETGet Reward Page API
      • POSTCreate a reward
      • GETGet reward information
      • POSTCreate a voucher
      • POSTCreate redeem voucher request
      • POSTComplete redeem voucher request
      • DELRevoke vouchers
      • POSTValidate a reward
LogoLogo
Help CenterAPI KeysStatusSign In
LoyaltyReward

Get voucher for a contact

GET
https://api.brevo.com/v3/loyalty/offer/programs/:pid/vouchers
GET
/v3/loyalty/offer/programs/:pid/vouchers
1import { BrevoClient } from "@getbrevo/brevo";
2
3async 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}
11main();
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      "validFrom": "2024-01-15T09:30:00Z"
16    }
17  ],
18  "count": 1,
19  "loyaltyProgramId": "string",
20  "loyaltySubscriptionId": "string"
21}
Get voucher for a contact
Was this page helpful?
Previous

Get Reward Page API

Next
Built with

Authentication

api-keystring

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

Path parameters

pidstringRequiredformat: "uuid"
Loyalty Program ID

Query parameters

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

Response

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

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error