LoyaltyBalance

Get balance definition list

Returns balance definition page

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-500Defaults to 200
Limit the number of records returned
offsetintegerOptional>=0Defaults to 0
Offset to paginate records
sortFieldenumOptionalDefaults to updated_at
Field to sort by
Allowed values:
sortenumOptionalDefaults to desc
Sort direction
Allowed values:
versionenumOptionalDefaults to draft
Version
Allowed values:

Response

Successful retrieval of balance definition page
itemslist of objects or null
list of balance definitions

Errors