Get Eligible Locations
Path parameters
Headers
Bearer authentication of the form Bearer <token>
, where token is your auth token.
Query parameters
Page number [>= 0], (default = 0)
Maximum number of locations to be returned [1 - 200], (default = 200)
Sort location names (1 for A-Z, -1 for Z-A)
Sort city names (1 for A-Z, -1 for Z-A)
Sort state names (1 for A-Z, -1 for Z-A)
City of location; REQUIRES state query parameter
Zip Code of location; CANNOT provide State, City, Longitude, Latitude, or Radius query params when using zipCode
State of location; REQUIRES city field
Category of merchant associated with location. Please use URL Encode for non single word categories. (Food & Beverage should be Food%20%26%20Beverage)
Longitude to search locations from [-180 - 180], REQUIRES latitude field
Latitude to search locations from [-90 - 90], REQUIRES longitude field
Radius to search for locations in miles [1 - 50], (default = 10). REQUIRES longitude & latitude fields
Time in string format for location createdDate search start (UTC)
Time in string format for location createdDate search end (UTC)
Response
Created date of location in Kard’s system (UTC)
Geo-coordinates of location
Last modified date of location in Kard’s system (UTC)