Get balance list

GET

https://api.brevo.com/v3/loyalty/balance/programs/:pid/contact-balances

Returns balance list

api-keystring

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

pidstringRequiredformat: "uuid"

Loyalty Program Id

Successful retrieval of contact balance

balanceDefinitionIdstring or null

balanceslist of objects or null

countinteger or null

loyaltyProgramIdstring or null

1	import requests
2
3	url = "https://api.brevo.com/v3/loyalty/balance/programs/pid/contact-balances"
4
5	headers = {"api-key": "<apiKey>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"balanceDefinitionId": "string",
3	"balances": [
4	{
5	"contactId": 1,
6	"loyaltySubscriptionId": "string",
7	"updatedAt": "string",
8	"value": 1.1
9	}
10	],
11	"count": 1,
12	"loyaltyProgramId": "string"
13	}