Reward properties are list of available properties for rewards resource.
All available methods for resource reward properties.
HTTP method | Endpoint | Description |
---|---|---|
[badge-blue GET] | /reward-properties | Get information about all reward properties |
[badge-blue GET] | /reward-properties/{reward_property_id} | Get information about a reward property |
Get information about reward properties
[badge-blue GET] /reward-properties
Parameter name | Type | Description | Mandatory (Yes/No) |
---|---|---|---|
count | integer | The number of records to return. Default value is 100. |
No |
offset | integer | The number of records from a collection to skip. Default value is 0. | No |
sort_field | string | One of the query string parameters for sorting. Response is sorted by the specified field. | No |
sort_direction | string | Direction of sorting the response list. Possible values are: ASC / DESC | No |
name | string | Name for the property | No |
Status code: 200 OK
Output structure : object
Parameter name | Type | Description |
---|---|---|
reward_properties | Property[] | List of all reward properties |
total_items | integer | Count of all found reward properties |
Get information about a specific reward property
[badge-blue GET] /reward-properties/{reward_property_id}
Parameter name | Type | Description |
---|---|---|
reward_property_id | string | The unique id for the reward property |
Status code: 200 OK
Output structure : Property