> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developers.brevo.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.brevo.com/_mcp/server.

# Get balance list

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

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

Reference: https://developers.brevo.com/reference/get-contact-balances

## Authentication

- `api-key` header (required) — The API key should be passed in the request headers as `api-key` for authentication.

## Request

### Path parameters

- `pid` (string, required) — Loyalty Program Id

### Query parameters

- `includeInternal` (boolean, optional) — Include balances tied to internal definitions.
- `limit` (integer, optional) — Limit the number of records returned
- `offset` (integer, optional) — Skip a number of records
- `sort` (enum, optional) — Sort order
  - Allowed values: `asc`, `desc`
- `sortField` (enum, optional) — Field to sort by
  - Allowed values: `updatedAt`, `value`
- `balanceDefinitionId` (string, required) — Balance Definition ID (required)

## Response

### 200

Successful retrieval of contact balance

- `balanceDefinitionId` (string, optional)
- `balances` (list of object, optional)
  - `contactId` (integer, optional)
  - `loyaltySubscriptionId` (string, optional)
  - `updatedAt` (string, optional)
  - `value` (double, optional)
- `count` (integer, optional)
- `loyaltyProgramId` (string, optional)

## Errors

### 401 Unauthorized Error

Request Authentication Failed

- `message` (string, required) — Readable message associated to the failure
- `code` (string, optional) — Error code displayed in case of a failure

### 403 Forbidden Error

Cannot Authenticate Request

- `message` (string, required) — Readable message associated to the failure
- `code` (string, optional) — Error code displayed in case of a failure

### 404 Not Found Error

subscription data not found for some contacts

- `message` (string, required) — Readable message associated to the failure
- `code` (string, optional) — Error code displayed in case of a failure

### 422 Unprocessable Entity Error

Validation errors

- `message` (string, required) — Readable message associated to the failure
- `code` (string, optional) — Error code displayed in case of a failure

### 500 Internal Server Error

Internal error occurred

- `message` (string, required) — Readable message associated to the failure
- `code` (string, optional) — Error code displayed in case of a failure

## Examples

**Response**

```json
{
  "balanceDefinitionId": "string",
  "balances": [
    {
      "contactId": 1,
      "loyaltySubscriptionId": "string",
      "updatedAt": "string",
      "value": 1.1
    }
  ],
  "count": 1,
  "loyaltyProgramId": "string"
}
```

**SDK Code**

```typescript
import { BrevoClient } from "@getbrevo/brevo";

async function main() {
    const client = new BrevoClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.balance.getContactBalances({
        pid: "pid",
        balanceDefinitionId: "balanceDefinitionId",
    });
}
main();

```

```python
from brevo import Brevo

client = Brevo(
    api_key="YOUR_API_KEY_HERE",
)

client.balance.get_contact_balances(
    pid="pid",
    balance_definition_id="balanceDefinitionId",
)

```

```php
<?php

namespace Example;

use Brevo\Brevo;
use Brevo\Balance\Requests\GetContactBalancesRequest;

$client = new Brevo(
    apiKey: 'YOUR_API_KEY_HERE',
);
$client->balance->getContactBalances(
    'pid',
    new GetContactBalancesRequest([
        'balanceDefinitionId' => 'balanceDefinitionId',
    ]),
);

```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.brevo.com/v3/loyalty/balance/programs/pid/contact-balances?balanceDefinitionId=balanceDefinitionId"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.brevo.com/v3/loyalty/balance/programs/pid/contact-balances?balanceDefinitionId=balanceDefinitionId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.brevo.com/v3/loyalty/balance/programs/pid/contact-balances?balanceDefinitionId=balanceDefinitionId")
  .header("api-key", "<apiKey>")
  .asString();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.brevo.com/v3/loyalty/balance/programs/pid/contact-balances?balanceDefinitionId=balanceDefinitionId");
var request = new RestRequest(Method.GET);
request.AddHeader("api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.brevo.com/v3/loyalty/balance/programs/pid/contact-balances?balanceDefinitionId=balanceDefinitionId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```