{"_id":"582b471fcdfdc125000c8685","category":{"_id":"582b4661cdfdc125000c8684","version":"56cacb1cc675f50b00a4b61c","__v":0,"project":"56cacb1bc675f50b00a4b619","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-11-15T17:31:13.213Z","from_sync":false,"order":5,"slug":"rewardsmojo-rest-api","title":"Rewards REST API"},"parentDoc":null,"project":"56cacb1bc675f50b00a4b619","__v":4,"user":"56caca84245b841300806def","version":{"_id":"56cacb1cc675f50b00a4b61c","project":"56cacb1bc675f50b00a4b619","__v":14,"createdAt":"2016-02-22T08:47:24.528Z","releaseDate":"2016-02-22T08:47:24.528Z","categories":["56cacb1dc675f50b00a4b61d","56cc10aaca43550b0028125a","56cc10b7b4cbcf0b004a5df9","56cc1bb2272aa4130002ccd2","56cc5834b4cbcf0b004a5f8b","56cda18bface161300dae13b","56d51f2873dcd20b00fb87bb","56fbe0610023171700b96105","57658310c176520e00ea9076","5772bdd48c48e00e00503638","577c1dfe87acf617003c3fcd","579525172979790e00771a15","582b4661cdfdc125000c8684","586365cedfe6cc3700a7be63"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-11-15T17:34:23.776Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n\t\"code\": 200,\n  \"count\": result_count\n\t\"results\": {\n    {\n      \"id\": rewards_id,\n      \"brand_name\": brand_name,\n      \"logo\": brand_logo,\n      \"offer\": reward_title,\n      \"value_formatted\": formatted_value,\n      \"value_numeric\": numeric_value,\n      \"fineprint\": reward_fine_print,\n      \"redemption_process\": reward_redemption_process,\n      \"support\": reward_support_channel,\n      \"currency\": currency_name,\n      \"value_ratio\": float_value,\n      \"valid_till\": validity\n    },\n\t\t{\n      ....\n\t\t},\n\t\t....\n\t}\n}","language":"json","status":200},{"name":"","code":"{\n\t\"code\": 400,\n  \"status\": \"fail\",\n  \"results\": error_message\n}","language":"json","status":400}]},"settings":"","examples":{"codes":[]},"method":"get","auth":"required","params":[{"_id":"582f2e7de367360f00bc5e2e","ref":"","in":"path","required":true,"desc":"App ID from the Codemojo dashboard","default":"","type":"string","name":"app_id"},{"_id":"582f5a351be8d5190036ce08","ref":"","in":"query","required":false,"desc":"Lets you get rewards customized to that location. Short country code (IN, GB etc.)","default":"","type":"string","name":"locale"},{"_id":"582f5a351be8d5190036ce07","ref":"","in":"query","required":false,"desc":"Latitude of the locale for which Rewards are to be retrieved for","default":"","type":"double","name":"lat"},{"_id":"582f5a351be8d5190036ce06","ref":"","in":"query","required":false,"desc":"Longitude of the locale for which Rewards are to be retrieved for","default":"","type":"double","name":"lon"},{"_id":"582f5a351be8d5190036ce05","ref":"","in":"query","required":false,"desc":"Testing flag. Set 1 to enable testing or 0 to disable","default":"","type":"int","name":"testing"},{"_id":"582f5a351be8d5190036ce04","ref":"","in":"query","required":false,"desc":"Unique device id of the device/user/platform","default":"","type":"string","name":"device_id"},{"_id":"582f5a351be8d5190036ce03","ref":"","in":"query","required":false,"desc":"Email of the user","default":"","type":"string","name":"email"},{"_id":"582f5a351be8d5190036ce02","ref":"","in":"query","required":false,"desc":"Phone of the user","default":"","type":"string","name":"phone"}],"url":"/v:version/services/rewards/list/available-rewards/:app_id"},"isReference":true,"order":1,"body":"Email / phone are optional for this API but they help to get a more personalized reward to the user","excerpt":"Get all the available rewards based on filter","slug":"get-available-rewards","type":"endpoint","title":"Get Available Rewards"}

getGet Available Rewards

Get all the available rewards based on filter

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

app_id:
required
string
App ID from the Codemojo dashboard

Query Params

locale:
string
Lets you get rewards customized to that location. Short country code (IN, GB etc.)
lat:
double
Latitude of the locale for which Rewards are to be retrieved for
lon:
double
Longitude of the locale for which Rewards are to be retrieved for
testing:
integer
Testing flag. Set 1 to enable testing or 0 to disable
device_id:
string
Unique device id of the device/user/platform
email:
string
Email of the user
phone:
string
Phone of the user

Result Format


Documentation

Email / phone are optional for this API but they help to get a more personalized reward to the user

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}