HomeGuidesDeveloper HubRelease Notes
Get supportBook a chat
Developer Hub
These docs are for v2.76. Click to read the latest docs for v2.208.

Get rewards

Gets details from all available rewards of all programs in your organization. If necessary, filter the results using Query Parameters.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

The query parameter memberid was used in the example to show how to filter the result of the API request, making it retrieve only the the reward list related to the specified member, which includes:

  • Non-segmented rewards and segmented rewards applicable to the member.
  • Rewards that have available stock and have not expired.

Check here some other query parameters that you can use to filter the response.

Response definitions

The following table describes each item in the response.

Response itemDescriptionData type
IdUnique identifier of the retrieved object.String
NameThe name of the reward.String
Query Params
string

Member ID (either a Salesforce Record ID or an external ID). It shows all Rewards the Member can redeem.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json