users > Rewards

Get Locations By User

Retrieve national and local geographic locations that a specified user has eligible in-store offers at. Use this endpoint to build out your map-specific UX experiences.<br/> <br/> <b>Required scopes:</b> rewards:read

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

Request

  • Base URL: https://rewards-api.getkard.com
  • URL: https://rewards-api.getkard.com/v2/issuers/{organizationId}/users/{userId}/locations
  • 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[name]string
filter[city]string

Case-insensitive substring match on the location's city. Never defines the search area; applied as an additional constraint alongside a radius search when filter[latitude]/filter[longitude]/filter[radius] are also provided.

filter[zipCode]string

Exact-match filter on the location's zip code. Never defines the search area; applied as an additional constraint alongside a radius search when filter[latitude]/filter[longitude]/filter[radius] are also provided.

filter[state]'AL' | 'AK' | 'AS' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FM' | 'FL' | 'GA' | 'GU' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MH' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'MP' | 'OH' | 'OK' | 'OR' | 'PW' | 'PA' | 'PR' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VI' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY'

Exact-match filter on the location's state. Never defines the search area; applied as an additional constraint alongside a radius search when filter[latitude]/filter[longitude]/filter[radius] are also provided.

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[longitude]number double

Longitude of the point to search around. Must be provided together with filter[latitude]; combine with filter[radius] to run a radius search.

filter[latitude]number double

Latitude of the point to search around. Must be provided together with filter[longitude]; combine with filter[radius] to run a radius search.

filter[radius]integer

Radius in miles to search around the point given by filter[latitude]/filter[longitude] (default 10, minimum 1). Has no effect unless both latitude and longitude are also provided — it is ignored when only filter[zipCode], filter[city], or filter[state] is used, without lat/long.

sort'locationName' | '-locationName'

If provided, response will be sorted by the specified fields. Defaults to newest first, equivalent to descending createdDate; when filter[latitude]/filter[longitude] are provided, locations are ordered by ascending distance from that point first, then newest first.

includestring

CSV list of included resources in the response (e.g "offers,categories"). Allowed values are offers and categories.

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

Available UI component types for offers

UI component types to include in included offers.

Response

Response with status 200

Changes

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