List all available rewards for a customer

get

https://api.staging.antavo.com/customers/{customer_id}/activities/rewards

This endpoints provides the list of all available rewards for a specific customer.

Path Params

customer_id

string

required

Unique customer ID. This can be

The Antavo customer ID
An external ID (requires configuration): {external_field:external_id_value}

Query Params

fields

string

enum

Comma separated list of non-standard fields to be included in the response. Accepted values:

claims: See the claimed rewards and associated information for each currently available reward.
custom_data: Access this field set in the reward configuration.
gallery: Provides, where available, image links specified in the reward configuration.
instructions: Access redeem instructions set in the reward configuration.
terms: Access terms and conditions set in the reward configuration.
Any custom attributes configued in the Entities module with cf_ prefix.

Allowed:

limit

integer

Defaults to 100

Limits the number of rewards to be returned in one response. Other values are accessible by pagination made accessible via the offset.

offset

integer

Defaults to 0

Offsets the starting number of rewards to return. This is used in pagination in conjunction with the limit query.

sort

string

Sorts the results by the selected value, which can be starts_at, ends_at, or order. This query can be used in conjunction with the order query.

order

string

Used in conjunction with the sort query to list the results in ascending or descending order. The value can be asc for an ascending order or desc for a descending order.

Responses

Language

Credentials

Query

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200List of rewards The list of information returned in the response depends on the type of the reward and its configured attributes. This example shows the attributes of a coupon reward.

404Customer not found