API ReferenceRewardsOffersDeprecated

Get Offers

Retrieve ALL national and local offer data regardless of whether a user is eligible to see them. This endpoint is a legacy endpoint and will no longer be maintained soon. Instead, use Get Eligible Offers to retrieve national merchant data and build 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

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

pageintegerOptional

Page number [>= 0], (default = 0)

limitintegerOptional

Maximum number of offers [1 - 200], (default = 200)

sourceenumOptional

Source of merchant associated with offer

Allowed values:
categoryenumOptional

Category of merchant associated with offer. Please use URL Encode for non single word categories. (Food & Beverage should be Food%20%26%20Beverage)

namestringOptional

Name of offer

offerTypeenumOptional

Type of offer (whether it is run online or in-store)

Allowed values:
merchantIdstringOptional

Merchant ID in Kard’s system

isTargetedbooleanOptional

True returns targeted offers, false returns targeted and non-targeted offers

startDateStartdatetimeOptional

Time in string format for offer startDate search (UTC)

startDateEnddatetimeOptional

Time in string format for offer startDate search (UTC)

expirationDateStartdatetimeOptional

Time in string format for offer expirationDate search (UTC)

expirationDateEnddatetimeOptional

Time in string format for offer expirationDate search (UTC)

startDateSortenumOptional

Sort offer start dates chronologically (1 for ascending, -1 for descending)

Allowed values:
expirationDateSortenumOptional

Sort offer expiration dates chronologically (1 for ascending, -1 for descending)

Allowed values:
merchantNameSortenumOptional

Sort merchant names (1 for A-Z, -1 for Z-A)

Allowed values:

Response

This endpoint returns a list of objects.
_idstring

Offer ID in Kard’s system

categoryenum

Category of merchant associated with offer

commissionTypeenum

Type of commission on offer (% or a flat $)

Allowed values:
createdDatedatetime

Created date of offer in Kard’s system (UTC)

expirationDatedatetime

Expiration date of offer if applicable (UTC)

isLocationSpecificboolean

True if offer is valid only for specific locations, false if valid for all locations. Note, this field is usually false

isTargetedboolean

True returns targeted offers, false returns targeted and non-targeted offers

lastModifieddatetime

Last modified date in Kard’s system (UTC)

merchantobject

Merchant associated with the offer

namestring

Name of offer

offerTypeenum

Type of offer (whether it is run online or in-store)

Allowed values:
redeemableOnceboolean

True if offer is redeemable only once, false if not

sourceenum

Source of merchant associated with offer

Allowed values:
startDatedatetime

Beginning date of offer (UTC)

termsstring

Terms and conditions on offer

totalCommissiondouble

Offer commission going to issuer and user summed up

issuersCommissiondoubleOptional

Commission going to the issuer

maxRewardAmountintegerOptional

Maximum Reward Amount, if available on offer

maxTransactionAmountintegerOptional

Maximum Transaction Amount allowed to redeem offer, if available on offer

minRewardAmountintegerOptional

Minimum Reward Amount, if available on offer

minTransactionAmountintegerOptional

Minimum Transaction Amount required to redeem offer, if available on offer

usersCommissiondoubleOptional

Commission going to user

Errors