GET /loyalty/balance/programs/{pid}/active-balance

Returns Active Balances

Servers

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

sortField String No

Sort Field

Valid values:

  • "createdAt"
sort String No

Sort Order

Valid values:

  • "desc"
  • "asc"
balanceDefinitionId String Yes

Balance Definition ID

contactId Integer Yes

Contact ID

offset Integer No

Offset

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.