Get Locations By User

curl -G https://rewards-api.getkard.com/v2/issuers/organization-123/users/user-123/locations \
     -H "Authorization: Bearer <token>" \
     -d "page[size]=1" \
     -d "filter[latitude]=39.9419429" \
     -d "filter[longitude]=-75.1446869" \
     -d "filter[radius]=10" \
     --data-urlencode include=offers,categories

{
  "data": [
    {
      "type": "location",
      "id": "5e27318c9b346f00087fba8l",
      "attributes": {
        "name": "Worlds Greatest Chicken",
        "address": {
          "street": "120 Main St",
          "city": "Philadelphia",
          "state": "PA",
          "zipCode": "19147"
        },
        "coordinates": {
          "longitude": -75.1446869,
          "latitude": 39.9419429
        },
        "phone": "+1 (123) 555-8880",
        "operationHours": {
          "periods": [
            {
              "close": {
                "day": 1,
                "time": "1700"
              },
              "open": {
                "day": 1,
                "time": "0900"
              }
            },
            {
              "close": {
                "day": 2,
                "time": "1700"
              },
              "open": {
                "day": 2,
                "time": "0900"
              }
            },
            {
              "close": {
                "day": 3,
                "time": "1700"
              },
              "open": {
                "day": 3,
                "time": "0900"
              }
            },
            {
              "close": {
                "day": 4,
                "time": "1700"
              },
              "open": {
                "day": 4,
                "time": "0900"
              }
            },
            {
              "close": {
                "day": 5,
                "time": "1700"
              },
              "open": {
                "day": 5,
                "time": "0900"
              }
            }
          ],
          "weekdayText": [
            "Monday: 9:00 AM – 5:00 PM",
            "Tuesday: 9:00 AM – 5:00 PM",
            "Wednesday: 9:00 AM – 5:00 PM",
            "Thursday: 9:00 AM – 5:00 PM",
            "Friday: 9:00 AM – 5:00 PM",
            "Saturday: Closed",
            "Sunday: Closed"
          ]
        },
        "partnerIds": [
          {
            "type": "google",
            "id": "3pafnweri4"
          }
        ],
        "cuisine": "Pizza Restaurant",
        "rating": {
          "value": 4.6,
          "count": 812
        },
        "priceLevel": "$$"
      },
      "relationships": {
        "category": {
          "data": [
            {
              "type": "category",
              "id": "65920081b524d126068de24a"
            }
          ]
        },
        "offers": {
          "data": [
            {
              "type": "standardOffer",
              "id": "5e27318c9b346f00087fbb5b"
            }
          ]
        }
      }
    }
  ],
  "links": {
    "self": "/v2/issuers/{organizationId}/users/{userId}/locations?page[size]=1&filter[latitude]=39.9419429&filter[longitude]=-75.1446869&filter[radius]=10&include=offers,categories",
    "prev": null,
    "next": "/v2/issuers/{organizationId}/users/{userId}/locations?page[after]=NDMyNzQyODI3OTQw&page[size]=1&filter[latitude]=39.9419429&filter[longitude]=-75.1446869&filter[radius]=10&include=offers,categories"
  },
  "included": [
    {
      "type": "category",
      "id": "65920081b524d126068de24a",
      "attributes": {
        "name": "Food & Beverage"
      }
    },
    {
      "type": "standardOffer",
      "id": "5e27318c9b346f00087fbb5c",
      "attributes": {
        "name": "Worlds Greatest Chicken",
        "terms": "Worlds Greatest Chicken offers are only available within US Locations.",
        "purchaseChannel": [
          "INSTORE"
        ],
        "userReward": {
          "type": "PERCENT",
          "value": 5.7
        },
        "startDate": "2022-01-01T05:00:00Z",
        "expirationDate": "2022-01-01T05:00:00Z",
        "minRewardAmount": {
          "type": "CENTS",
          "value": 500
        },
        "maxRewardAmount": {
          "type": "CENTS",
          "value": 2000
        },
        "minTransactionAmount": {
          "type": "CENTS",
          "value": 500
        },
        "maxTransactionAmount": {
          "type": "CENTS",
          "value": 2000
        },
        "maxRedemptions": 1,
        "isTargeted": true,
        "assets": [
          {
            "url": "http://attribution.getkard.com/logos/breakfastbunny_logo.png?eventCode=IMPRESSION&type=offerAttribution&medium=BROWSE&offerId=629fc220b7a4290009a188ec&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyZWZlcnJpbmdQYXJ0bmVyVXNlcklkIjoiNDM4MTAzIiwiaXNzdWVySWQiOiIwMDAwNDMyMSIsInR5cGUiOiJPRkZFUiIsInBheWxvYWQiOnsiand0VGltZXN0YW1wIjoiMjAyNi0wNC0yMyJ9fQ.4f9QmoGpgXVIXu9Tq8XFVcx7Rz0jptsYNYpmaIBszyc&state=eyJyYW5rIjoxLCJmaWx0ZXJzIjpbXX0%3D",
            "alt": "",
            "type": "IMG_VIEW"
          },
          {
            "url": "https://attribution.getkard.com/public/banners/breakfast-bunny-banner.jpg?eventCode=VIEW&type=offerAttribution&medium=BROWSE&offerId=629fc220b7a4290009a188ec&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyZWZlcnJpbmdQYXJ0bmVyVXNlcklkIjoiNDM4MTAzIiwiaXNzdWVySWQiOiIwMDAwNDMyMSIsInR5cGUiOiJPRkZFUiIsInBheWxvYWQiOnsiand0VGltZXN0YW1wIjoiMjAyNi0wNC0yMyJ9fQ.4f9QmoGpgXVIXu9Tq8XFVcx7Rz0jptsYNYpmaIBszyc&state=eyJyYW5rIjoxLCJmaWx0ZXJzIjpbXX0%3D",
            "alt": "",
            "type": "BANNER_VIEW"
          },
          {
            "url": "https://attribution.getkard.com/public/franki/venue/a3f2c81d0b7e4a55-storefront.jpg?eventCode=IMPRESSION&type=offerAttribution&medium=BROWSE&offerId=629fc220b7a4290009a188ec&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyZWZlcnJpbmdQYXJ0bmVyVXNlcklkIjoiNDM4MTAzIiwiaXNzdWVySWQiOiIwMDAwNDMyMSIsInR5cGUiOiJPRkZFUiIsInBheWxvYWQiOnsiand0VGltZXN0YW1wIjoiMjAyNi0wNC0yMyJ9fQ.4f9QmoGpgXVIXu9Tq8XFVcx7Rz0jptsYNYpmaIBszyc&state=eyJyYW5rIjoxLCJmaWx0ZXJzIjpbXX0%3D",
            "alt": "",
            "type": "LOCATION_IMG_VIEW"
          }
        ],
        "websiteUrl": "http://worldsgreatestchickent.test.com",
        "description": "Worlds Greatest Chicken brings you the tastiest crispy, double fried spicy chicken in the world."
      }
    }
  ]
}

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.

Required scopes: rewards:read

Authentication

AuthorizationBearer

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

Path parameters

organizationIdstringRequired

Your issuer organization ID, provided by Kard

userIdstringRequired

The ID of the user as defined on the issuers system

Query parameters

page[size]integerOptional

page[after]stringOptional

page[before]stringOptional

filter[name]stringOptional

filter[city]stringOptional

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]stringOptional

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]enumOptional

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]enumOptional

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

filter[longitude]doubleOptional

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]doubleOptional

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]integerOptional

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.

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.

sortenumOptional

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.

Allowed values:

includestringOptional

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

supportedComponentsenumOptional

UI component types to include in included offers.

Response

This endpoint returns an object.

datalist of objects

linksobject

Errors

400

Invalid Request

401

Unauthorized Error

404

Does Not Exist Error

500

Internal Server Error