Get Active Balances API | Brevo API Documentation

Returns Active Balances

Authentication

api-keystring

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

Path parameters

pidstringRequiredformat: "uuid"

Loyalty Program Id

Query parameters

limitintegerOptional1-500

Limit

offsetintegerOptional>=0

Offset

sortFieldenumOptional

Sort Field

Allowed values:

sortenumOptional

Sort Order

Allowed values:

contactIdlongRequired>=1

Contact ID

balanceDefinitionIdstringRequiredformat: "uuid"

Balance Definition ID

includeInternalbooleanOptional

Include balances tied to internal definitions.

Response

Successful retrieval of active balances

countlong

Total number of active balances.

loyaltyProgramIdstringformat: "uuid"

Unique identifier of the loyalty program.

contactIdlong

Unique identifier of the contact.

balanceDefinitionIdstringformat: "uuid"

Unique identifier of the balance definition.

activeBalanceslist of objects

List of active balances.

Errors

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

1	{
2	"count": 1,
3	"loyaltyProgramId": "string",
4	"contactId": 1,
5	"balanceDefinitionId": "string",
6	"activeBalances": [
7	{
8	"id": "string",
9	"amount": 1.1,
10	"createdAt": "2024-01-15T09:30:00Z",
11	"expiresAt": "2024-01-15T09:30:00Z"
12	}
13	]
14	}