Get available challenges

When no StoreId or ChainId is provided, all available challenges for the customer are returned. When StoreId and/or ChainId are provided, only the challenges available for the specified store/chain are returned. If both StoreId and ChainId are provided, challenges available in specified store or specified chain are returned. If Challenge is configured with list of chains, but only StoreId is provided in the request, challenges available for the chain are not returned.

GET /v3/cards

Get available challenges

cURL

curl --request GET \
  --url https://{host}/challenge/v3/cards \
  --header 'Authorization: <api-key>' \
  --header 'memberId: <memberid>'

200

[
  {
    "hideInList": true,
    "isActive": true,
    "currentProgress": 123,
    "cardsActivatedCount": 123,
    "closedAt": "2023-11-07T05:31:56Z",
    "cardId": "<string>",
    "currentTier": 123,
    "cardDetails": {
      "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "activityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "requiredProgress": 123,
      "startDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "imageUrl": "<string>",
      "details": "<string>",
      "termsAndConditions": "<string>",
      "activationLimit": 123,
      "backgroundImageUrl": "<string>",
      "chainIds": [
        "<string>"
      ],
      "storeIds": [
        "<string>"
      ],
      "rewardType": "Coupon",
      "progressCalculationType": "ProductCount",
      "isSinglePurchase": true,
      "completionLabel": "<string>",
      "completedCardsLabel": "<string>",
      "completedCardsCount": 123,
      "progressLabel": "<string>",
      "unitOfMeasure": "Item",
      "couponRewards": [
        {
          "offerId": "<string>"
        }
      ],
      "bonusRewards": [
        {
          "bonusAmount": 123
        }
      ],
      "customRewards": [
        {
          "name": "<string>"
        }
      ],
      "tags": [
        "<string>"
      ]
    }
  }
]

Authorizations

Authorization · string · header · required

Opaque Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Headers

memberId · string · required

Current customer id.

Query Parameters

storeId · string

The selected store to retrieve related available cards.

chainId · string

The selected chain to retrieve related available cards.

Response

200

application/json

OK

hideInList · boolean · required

Configuration to make the challenge card invisible.

isActive · boolean

Specifies if the card can accumulate progress. True after manual activation, or automatically for preactivated challenges.

currentProgress · number<double>

Progress accumulated for the specific instance of challenge. Can be integer when calculation types are ProductCount and StoreVisit, or a float value otherwise.

cardsActivatedCount · integer<int32>

Amount of cards that user has activated in the given challenge. Includes current card, if it was activated.

closedAt · string<date-time> | null

Populated only if the card was already completed. Such cards no longer accumulate progress, so user can see what they already completed. Closed cards are returned until their challenge expires.

cardId · string | null

Id of the specific card. If challenge is renewable, this id will be different on each of the cards, while ActivityId will be the same. Will be null, if card is not activated.

currentTier · integer<int32> | null

The highest tier reached on this card. Null for non-tiered challenges or when no tier has been reached yet.

cardDetails · object

Show child attributes