v1
latestOpenAPI 3.0.02026-07-26868170.3 KBList rewards
Get the list of created rewards.
Query parameters
Number of items displayed.
display result asc or desc
display result sorting by a result field (nqp_value is the only allowed field)
Display elements before cursor X.
Display elements after cursor X.
allows search on name property. Operators: equals, not equals, contains, begins, ends
allows search on external_id property. Operators: equals, not equals, contains, begins, ends
allows search on monetary property. Operators: equals, not equals
allows search on monetary_type property. Operators: equals, not equals, contains, begins, ends
allows search on monetary_value property. Operators: equals, not equals, gt, gte, lt, lte
allows search on nqp_value property. Operators: equals, not equals, gt, gte, lt, lte
allows search on description property. Operators: equals, not equals, contains, begins, ends
allows search on rich_description property. Operators: equals, not equals, contains, begins, ends
allows search on image_url property. Operators: equals, not equals, contains, begins, ends
allows search on holding_days property. Operators: equals, not equals, gt, gte, lt, lte
allows search on validity_interval_type property. Operators: equals, not equals, contains, begins, ends
allows search on validity_interval_count property. Operators: equals, not equals, gt, gte, lt, lte
allows search on forced_validity property. Operators: equals, not equals
allows search on forced_validity_start property. Operators: equals, not equals, gt, gte, lt, lte
allows search on forced_validity_end property. Operators: equals, not equals, gt, gte, lt, lte
allows search on limited property. Operators: equals, not equals
allows search on auto_generated property. Operators: equals, not equals
allows search on max_attribution_count property. Operators: equals, not equals, gt, gte, lt, lte
This is filter to apply to request. c0 is an exemple but how can use all custom field by name or id. Payload has give value and comparaison operator: c0={value: 12, operator: lte}. Operator depend on your filed type (text, number, date)
Response
Rewards retrieval is successful.