Retrieve national offers data that a specified user is eligible for. Call this endpoint to build out your targeted offers UX experience. Local merchants and offers details can be found by calling the Get Eligible Locations endpoint with the includeLocal query parameter.
Required scopes: rewards:read
Referring partner user ID from issuer that specifies user
Page number [>= 0], (default = 0)
Maximum number of offers to be returned [1 - 200], (default = 200)
Merchant ID in Kard’s system
Type of offer (whether it is run online or in-store)
Category of merchant associated with offer. Please use URL Encode for non single word categories. (Food & Beverage should be Food%20%26%20Beverage)
True returns targeted offers, false returns targeted and non-targeted offers
Sort offer start dates chronologically (1 for ascending, -1 for descending)
Sort offer expiration dates chronologically (1 for ascending, -1 for descending)
Sort merchant names (1 for A-Z, -1 for Z-A)
Offer ID in Kard’s system
Category of merchant associated with offer
Type of commission on offer (% or a flat $)
Created date of offer in Kard’s system (UTC)
Expiration date of offer if applicable (UTC)
True if offer is valid only for specific locations, false if valid for all locations. Note, this field is usually false
True returns targeted offers, false returns targeted and non-targeted offers
Last modified date in Kard’s system (UTC)
Name of offer
Type of offer (whether it is run online or in-store)
True if offer is redeemable only once, false if not
Source of merchant associated with offer
Beginning date of offer (UTC)
Terms and conditions on offer
Offer commission going to issuer and user summed up
Image URL asset containing attribution tokens
Commission going to the issuer
Maximum Reward Amount, if available on offer
Maximum Transaction Amount allowed to redeem offer, if available on offer
Minimum Reward Amount, if available on offer
Minimum Transaction Amount required to redeem offer, if available on offer
Commission going to user