GET /loyalty/balance/programs/{pid}/contact-balances
Returns contact balances for a given balance definition across all subscriptions.
Servers
- https://api.brevo.com/v3
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
pid |
String | Yes |
Loyalty Program Id |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
includeInternal |
Boolean | No |
Include balances tied to internal definitions. |
limit |
Integer | No |
Limit the number of records returned |
sortField |
String | No |
Field to sort by Valid values:
|
sort |
String | No |
Sort order Valid values:
|
balanceDefinitionId |
String | Yes |
Balance Definition ID (required) |
offset |
Integer | No |
Skip a number of records |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.