Get all available Choice Products

This endpoint allows you to retrieve all Choice Products available in your Tango platform catalog. It provides product details such as reward name, currency, and eligible countries, enabling seamless integration of global reward or incentive options into your application.

Use case

Acme Health wants to show patients, in its wellness and chronic‑care programs, only the rewards they can actually redeem. It uses this endpoint to dynamically retrieve a list of eligible digital reward options, filtered by country, currency, and program-specific reward names.

By calling this endpoint after a patient completes an action (such as finishing a wellness module or meeting wellness goals), Acme Health pulls the up‑to‑date catalog of active Choice Products and displays them in the app, ensuring the reward options are accurate, compliant, and personalized to each member’s location and program before issuing the selected reward.

Endpoint

Use the following endpoint to get all available Choice Products in your Tango platform's catalog:

FunctionPurpose
GET {URI}/choiceProductsGet all available Choice Products.

Parameters

To filter the results, use the following query parameters with this endpoint:

Query paramsData typeDescription
rewardNamestringUse this filter to retrieve Choice Products that match a specific reward name.
currencyCodestringUse this filter to retrieve results by the currency associated with the Choice Product.
countriesarray of stringsUse this filter to search products based on the countries where they’re available.

Response body notes

On a successful request (200 OK), the response body includes several important fields. Below are some key notes and considerations to help you understand field behaviors and best practices:

  • UTID is what you need for ordering: The utid from this response is the identifier you pass when placing an order. Don't hardcode UTIDs — always reference the latest response.
  • Choice Products only: This endpoint returns only Choice Products (Reward Link®, Global Choice Link, Promo Link™, Disbursement Link). Use GET /catalogs for the full catalog including standard items.

Examples

The following example is the generic payload with this endpoint showing the basic shape of a successful response. CurrencyCode value is returned as a three-letter currency code, such as PLN, MXN, USD, etc. while countries contains two-letter country codes, such as PL, MX, US, BR, etc.

{
  "choiceProducts": [
    {
      "utid": "string",
      "rewardName": "string",
      "currencyCode": "string",
      "countries": [
        "string"
      ]
    }
  ]
}

This example shows what a real-world response may look like when your platform has active Tango Choice Products. It includes actual sample values like UTIDs and product names. Your catalog may contain multiple Choice Products. Each entry includes: utid, rewardName, currencyCode, status, and countries such as US:

{
  "choiceProducts": [
    {
      "utid": "U014000",
      "rewardName": "Club Management",
      "currencyCode": "USD",
      "countries": [
        "US"
      ]
    },
    {
      "utid": "U081773",
      "rewardName": "Global Choice Link",
      "currencyCode": "USD",
      "countries": [
        "NL",
        "SE",
        "AT",
        "FI",
        "GR",
        "IE",
        "LV",
        "LT",
        "LU",
        "PT",
        "SK",
        "SI",
        "IN",
        "AE",
        "AR",
        "NZ",
        "SG",
        "TR",
        "PL",
        "PH",
        "QA",
        "BH",
        "SA",
        "BD",
        "BG",
        "CZ",
        "DK",
        "EG",
        "HU",
        "GB",
        "ID",
        "MY",
        "NO",
        "OM",
        "PK",
        "RO",
        "RS",
        "LK",
        "CH",
        "TW",
        "TH",
        "IL",
        "PE",
        "US",
        "CA",
        "MX",
        "BR",
        "AU",
        "JP",
        "FR",
        "DE",
        "IT",
        "ES",
        "PR",
        "BE"
      ]
    },

This example shows what the API returns when something goes wrong— such as 401 Unauthorized, invalid parameters, authentication errors, or other failures. It includes the typical fields returned in an error response. The error response includes metadata and helps you understand how to detect and handle errors.

{
  "timestamp": "2025-02-21T23:23:13.930Z",
  "requestId": "string",
  "path": "string",
  "httpCode": 0,
  "httpPhrase": "string",
  "i18nKey": "string",
  "message": "The error message will show here for error codes ",
  "errors": [
    {}
  ]
}

The possible response codes for this endpoint are as follows. For details, see i18nkey codes and their error messages:

Response codeMeaning
200The request was successful..
400The server could not understand the request due to invalid syntax.
401Authentication is required and has either not been provided or failed.
403The server understood the request but refuses to authorize it.


© 2026 Tango API are provided by Tango, a division of BHN, Inc.