Reward Sciences Documentation
By default, all requests receive the v1 version of the API. We encourage you to explicitly request this version via the Accept header.
All API access is over HTTPS, and accessed from the https://api.rewardsciences.com.
All data is sent and received as JSON.
All timestamps are returned in ISO 8601 format (
You can issue a GET request to the root endpoint to get all the endpoint categories that the API supports:
The OAuth2 standard protocol is used to grant API access to each organization.
Authenticate your requests sending an OAuth2 token on their
curl -H "Authorization: Bearer OAUTH-TOKEN" https://api.rewardsciences.com
These tokens can be obtained on the Reward Sciences web app, under ‘Developer Settings/API Tokens’. If your API Tokens get compromised you can always revoke them and obtain new ones.
API Tokens are to be used on server-to-server scenarios only. Do not leak your API Tokens to your end users.
Requests that return multiple items will be paginated to 25 items and return the first page by default. You can navigate through pages and override this behavior by using the following parameters:
|Parameter Name||Description||Default Value|
|limit||The number of items you want to be retrieved.||25|
|offset||The number of items you want to skip before starting the retrieval.||0|
curl 'https://api.rewardsciences.com/reward_categories?limit=100&offset=0' curl 'https://api.rewardsciences.com/reward_categories?limit=100&offset=100'
Our API is based on 4 key operations:
- Identify a User
- Track an Activity
- List Rewards
- Redeedem a reward or bid on a reward auction