Get balance list | Brevo API Documentation

Returns contact balances for a given balance definition across all subscriptions.

api-keystring

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

pidstringRequiredformat: "uuid"

Loyalty Program Id

includeInternalbooleanOptional

Include balances tied to internal definitions.

limitintegerOptional1-500

Limit the number of records returned

offsetintegerOptional>=0

Skip a number of records

sortenumOptional

Sort order

Allowed values:

sortFieldenumOptional

Field to sort by

Allowed values:

balanceDefinitionIdstringRequiredformat: "uuid"

Balance Definition ID (required)

Successful retrieval of contact balance

balanceDefinitionIdstring

balanceslist of objects

countinteger

loyaltyProgramIdstring

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.balance.getContactBalances("pid", {
8	balanceDefinitionId: "balanceDefinitionId",
9	});
10	}
11	main();

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	}

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.balance.getContactBalances("pid", {
8	balanceDefinitionId: "balanceDefinitionId",
9	});
10	}
11	main();

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	}