Get loyalty program list

GET

https://api.brevo.com/v3/loyalty/config/programs

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:

sortstringOptional

Sort documents by field

Loyalty Program page

itemslist of objects or null

Loyalty Program list

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