Get loyalty program list | Brevo API Documentation

Returns list of loyalty programs

api-keystring

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

limitintegerOptional

Number of documents per page

offsetintegerOptional

Index of the first document in the page

sort_fieldenumOptional

Sort documents by field

Allowed values:

sortenumOptional

Sort order

Allowed values:

Loyalty Program page

itemslist of objects

Loyalty Program list

400

Bad Request Error

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.program.getLpList({});
8	}
9	main();

1	{
2	"items": [
3	{
4	"id": "string",
5	"name": "string",
6	"description": "string",
7	"meta": {},
8	"state": "inactive",
9	"subscriptionPoolId": "string",
10	"subscriptionGeneratorId": "string",
11	"pattern": "string",
12	"codeCount": 1,
13	"documentId": "string",
14	"birthdayAttribute": "string",
15	"createdAt": "2024-01-15T09:30:00Z",
16	"updatedAt": "2024-01-15T09:30:00Z"
17	}
18	]
19	}