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

Returns balance definition page

Servers

Path parameters

Name Type Required Description
pid String Yes

Loyalty Program Id

Query parameters

Name Type Required Description
limit Integer No

Limit the number of records returned

Default value: 200

sortField String No

Field to sort by

Valid values:

  • "name"
  • "created_at"
  • "updated_at"

Default value: "updated_at"

sort String No

Sort direction

Valid values:

  • "desc"
  • "asc"

Default value: "desc"

version String No

Version

Valid values:

  • "active"
  • "draft"

Default value: "draft"

offset Integer No

Offset to paginate records

Default value: 0

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.