Reward Suppliers

List reward suppliers

Returns all reward supplier configurations for the client, across all supplier types. Reward suppliers are integrations with upstream providers that fulfil reward issuance (gift cards, coupons, payouts, etc.). Use the types query parameter to filter by supplier type.

get/v6/reward-suppliers

Query parameters

include_archivedboolean

typesstring[]

Response

Successful response

Example response

[
  {
    "cash_back_max": "handlebars@buildtime:{{cashBackMax}}",
    "cash_back_min": "handlebars@buildtime:{{cashBackMin}}",
    "cash_back_percentage": "handlebars@buildtime:{{cashBackPercentage}}",
    "created_date": "2025-10-24T02:00:00-07:00",
    "display_name": "handlebars@buildtime:{{displayName}}",
    "display_type": "handlebars@buildtime:{{displayType}}",
    "enabled": "handlebars@buildtime:{{enabled}}",
    "face_value": "handlebars@buildtime:{{faceValue}}",
    "face_value_algorithm_type": "handlebars@buildtime:{{faceValueAlgorithmType}}",
    "face_value_type": "handlebars@buildtime:{{faceValueType}}",
    "limit_per_day": "handlebars@buildtime:{{limitPerDay}}",
    "limit_per_hour": "handlebars@buildtime:{{limitPerHour}}",
    "name": "handlebars@buildtime:{{name}}",
    "reward_expires_at": "2025-10-24T02:00:00-07:00",
    "updated_date": "2025-10-24T02:00:00-07:00"
  }
]

Changes

No recorded changes to this endpoint across all 1 revision of this API.