get
https://[[app:Instance URL]]/services/apexrest/FieloPLT/v1/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
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
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.
Some other parameters you can use to filter are:
| Query Parameters | Description | Data type |
|---|---|---|
| fields | A comma-separated list of fields (API name) to return new fieldsets in the response. | String |
| limit | The number of records to return. | Int |
| offset | The number of records from a collection to skip. | Int |
| orderby | Records returned in an ascending or descending order. | String |
Response definitions
The following table describes each item in the response.
| Response item | Description | Data type |
|---|---|---|
| type | API name of the Reward object. | String |
| url | Path to the retrieved object. | String |
| Id | Unique identifier of the retrieved object. | String |
| Name | The name of the reward. | String |