users > Rewards

Get Offers By User

Retrieve national brand offers that a specified user is eligible for. Call this endpoint to build out your targeted offers UX experience. Local offers details can be found by calling the Get Eligible Locations.<br/> <b>Required scopes:</b> rewards:read

get/v2/issuers/{organizationId}/users/{userId}/offers

Request

  • Base URL: https://rewards-api.getkard.com
  • URL: https://rewards-api.getkard.com/v2/issuers/{organizationId}/users/{userId}/offers
  • Auth: HTTP bearer

Path parameters

organizationIdstring required

Your issuer organization ID, provided by Kard

userIdstring required

The ID of the user as defined on the issuers system

Query parameters

page[size]integer
page[after]string
page[before]string
filter[search]string

Case-insensitive substring search. Returns offers whose offer name or category name contains the search string.

filter[purchaseChannel]CommonsPurchaseChannel[]
filter[category]'Arts & Entertainment' | 'Baby, Kids & Toys' | 'Books & Digital Media' | 'Clothing, Shoes & Accessories' | 'Computers, Electronics & Software' | 'Convenience' | 'Gas' | 'Department Stores' | 'Food & Beverage' | 'Health & Beauty' | 'Home & Garden' | 'Miscellaneous' | 'Occasions & Gifts' | 'Pets' | 'Sports & Outdoors' | 'Supplies & Services' | 'Travel'

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

filter[isTargeted]boolean
sort'startDate' | '-startDate' | 'expirationDate' | '-expirationDate' | 'name' | '-name'

If provided, response will be sorted by the specified fields

includestring

CSV list of included resources in the response (e.g "categories"). Allowed value is categories.

supportedComponents'shortDescription' | 'longDescription' | 'baseReward' | 'boostedReward' | 'cta' | 'tags' | 'detailTags' | 'logoFlare' | 'progressBar'

Available UI component types for offers

UI component types to include in the response.

Response

Response with status 200

Changes

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