API Reference

Get redemption history

get
https://kigo-core-server-stage.kigodigital.net/api/v1/offers/redemption-history

Returns a paginated list of redeemed offers with total savings. Supports sorting, date range filtering, and redemption type filtering.

Query Params
int32
≥ 0

Limit the number of results returned

int32
≥ 0

Offset the results returned

string

Sort field: date, merchant_name, amount, redemption_type

string

Sort order: ascending or descending (default: descending)

string

Start date filter (inclusive), format: yyyy-mm-dd

string

End date filter (inclusive), format: yyyy-mm-dd

redemption_type[]
array of strings

Filter by redemption type(s): INSTORE, PRINT, MOBILE, PURCHASE, CLICKTHRU

redemption_type[]
int64

Filter to redemptions for a single offer (offer.offers.offer_id)

int64

Filter to redemptions at a single location (redemption.redemptions.redemption_location_id)

Responses

Updated 2 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago