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 endpoint with the includeLocal query parameter.
Required scopes: rewards:read

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[purchaseChannel]list of "INSTORE" or "ONLINE"Optional

Allowed values: INSTOREONLINE

filter[category]enumOptional

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

filter[isTargeted]booleanOptional

sortenumOptional

If provided, response will be sorted by the specified fields

includestringOptional

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

Response

This endpoint returns an object.

datalist of objects

linksobject

Errors

1 curl -G https://rewards-api.getkard.com/v2/issuers/{organizationId}/users/{userId}/offers \ 2 -H "Authorization: Bearer <token>" \ 3 -d "page[size]"=1 \ 4 -d "filter[isTargeted]"=true \ 5 -d sort=-startDate

1 { 2 "data": [ 3 { 4 "type": "purchaseCountOffer", 5 "attributes": { 6 "assets": [ 7 { 8 "type": "LOGO_IMAGE", 9 "url": "http://assets.getkard.com/logo/img?attribution-tokens", 10 "alt": "Worlds Greatest Chicken Logo Image" 11 }, 12 { 13 "type": "BANNER_IMAGE", 14 "url": "http://assets.getkard.com/banner/img?attribution-tokens", 15 "alt": "Worlds Greatest Chicken Banner Image" 16 } 17 ], 18 "expirationDate": "2025-03-17T05:00:00Z", 19 "isTargeted": true, 20 "name": "Worlds Greatest Chicken", 21 "purchaseChannel": [ 22 "INSTORE" 23 ], 24 "startDate": "2024-11-17T05:00:00Z", 25 "terms": "Worlds Greatest Chicken offers are only available within US Locations.", 26 "userReward": { 27 "type": "PERCENT", 28 "value": 5.7 29 }, 30 "description": "Worlds Greatest Chicken brings you the tastiest crispy, double fried spicy chicken in the world.", 31 "maxRedemptions": 1, 32 "maxRewardAmount": { 33 "type": "CENTS", 34 "value": 2000 35 }, 36 "maxTransactionAmount": { 37 "type": "CENTS", 38 "value": 10000 39 }, 40 "minRewardAmount": { 41 "type": "CENTS", 42 "value": 500 43 }, 44 "minTransactionAmount": { 45 "type": "CENTS", 46 "value": 500 47 }, 48 "websiteUrl": "http://worldsgreatestchickent.test.com" 49 }, 50 "id": "5e27318c9b346f00087fbb5c", 51 "relationships": { 52 "category": { 53 "data": [ 54 { 55 "type": "category", 56 "id": "65920081b524d126068de24a" 57 }, 58 { 59 "type": "category", 60 "id": "65920081b524d126068de24c" 61 } 62 ] 63 } 64 } 65 } 66 ], 67 "links": { 68 "self": "/v2/issuers/{organizationId}/users/{userId}/offers?page[size]=1?sort=-startDate", 69 "prev": null, 70 "next": "/v2/issuers/{organizationId}/users/{userId}/offers?page[after]=NDMyNzQyODI3OTQw&page[size]=1?&sort=-startDate" 71 }, 72 "included": [ 73 { 74 "type": "category", 75 "id": "65920081b524d126068de24a", 76 "attributes": { 77 "name": "Food & Beverage" 78 } 79 }, 80 { 81 "type": "category", 82 "id": "65920081b524d126068de24c", 83 "attributes": { 84 "name": "Department Stores" 85 } 86 } 87 ] 88 }

1	curl -G https://rewards-api.getkard.com/v2/issuers/{organizationId}/users/{userId}/offers \
2	-H "Authorization: Bearer <token>" \
3	-d "page[size]"=1 \
4	-d "filter[isTargeted]"=true \
5	-d sort=-startDate

1	{
2	"data": [
3	{
4	"type": "purchaseCountOffer",
5	"attributes": {
6	"assets": [
7	{
8	"type": "LOGO_IMAGE",
9	"url": "http://assets.getkard.com/logo/img?attribution-tokens",
10	"alt": "Worlds Greatest Chicken Logo Image"
11	},
12	{
13	"type": "BANNER_IMAGE",
14	"url": "http://assets.getkard.com/banner/img?attribution-tokens",
15	"alt": "Worlds Greatest Chicken Banner Image"
16	}
17	],
18	"expirationDate": "2025-03-17T05:00:00Z",
19	"isTargeted": true,
20	"name": "Worlds Greatest Chicken",
21	"purchaseChannel": [
22	"INSTORE"
23	],
24	"startDate": "2024-11-17T05:00:00Z",
25	"terms": "Worlds Greatest Chicken offers are only available within US Locations.",
26	"userReward": {
27	"type": "PERCENT",
28	"value": 5.7
29	},
30	"description": "Worlds Greatest Chicken brings you the tastiest crispy, double fried spicy chicken in the world.",
31	"maxRedemptions": 1,
32	"maxRewardAmount": {
33	"type": "CENTS",
34	"value": 2000
35	},
36	"maxTransactionAmount": {
37	"type": "CENTS",
38	"value": 10000
39	},
40	"minRewardAmount": {
41	"type": "CENTS",
42	"value": 500
43	},
44	"minTransactionAmount": {
45	"type": "CENTS",
46	"value": 500
47	},
48	"websiteUrl": "http://worldsgreatestchickent.test.com"
49	},
50	"id": "5e27318c9b346f00087fbb5c",
51	"relationships": {
52	"category": {
53	"data": [
54	{
55	"type": "category",
56	"id": "65920081b524d126068de24a"
57	},
58	{
59	"type": "category",
60	"id": "65920081b524d126068de24c"
61	}
62	]
63	}
64	}
65	}
66	],
67	"links": {
68	"self": "/v2/issuers/{organizationId}/users/{userId}/offers?page[size]=1?sort=-startDate",
69	"prev": null,
70	"next": "/v2/issuers/{organizationId}/users/{userId}/offers?page[after]=NDMyNzQyODI3OTQw&page[size]=1?&sort=-startDate"
71	},
72	"included": [
73	{
74	"type": "category",
75	"id": "65920081b524d126068de24a",
76	"attributes": {
77	"name": "Food & Beverage"
78	}
79	},
80	{
81	"type": "category",
82	"id": "65920081b524d126068de24c",
83	"attributes": {
84	"name": "Department Stores"
85	}
86	}
87	]
88	}