Get Reward Page API | Brevo API Documentation

Returns a reward page

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

statestringOptionalDefaults to all

State of the reward

versionenumOptionalDefaults to draft

Version

Allowed values:

Reward list successfully retrieved

itemslist of objects

Items for the current reward

totalCountinteger

Count of the associated parameter in current reward

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

424

Failed Dependency 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.getRewardPageApi("pid", {});
8	}
9	main();

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.getRewardPageApi("pid", {});
8	}
9	main();