Get Locations By User
Retrieve national and local geographic locations that a specified user has eligible in-store offers at. To
include local locations, add the includeLocal query parameter to your api call. Use this endpoint to build
out your map-specific UX experiences. Please note
that Longitude and Latitude fields are prioritized over State, City and Zipcode and are the recommended search
pattern.
Required scopes: rewards:read
Path parameters
organizationId
Your issuer organization ID, provided by Kard
userId
The ID of the user as defined on the issuers system
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
page[size]
page[after]
page[before]
filter[name]
filter[city]
filter[zipCode]
filter[state]
filter[category]
Category of merchant. Please use URL Encode for non single word categories. (Food & Beverage should be Food%20%26%20Beverage)
filter[longitude]
filter[latitude]
filter[radius]
sort
If provided, response will be sorted by the specified fields
Allowed values:
include
CSV list of included resources in the response (e.g “offers,categories”). Allowed values are offers and categories.
Response
This endpoint returns an object.
data
links
Related links to the API call
included