campaignIdnumber
Filter results by campaign ID.
sortstring
The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`.
**Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
valuestring
Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
createdBeforestring (date-time)
Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
createdAfterstring (date-time)
Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
validstring
Either "expired", "validNow", or "validFuture". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future.
One ofexpiredvalidNowvalidFuture
usablestring
Either "true" or "false". If "true", only coupons where `usageCounter < usageLimit` will be returned, "false" will return only coupons where `usageCounter >= usageLimit`.
One oftruefalse
referralIdinteger (int64)
Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.
recipientIntegrationIdstring
Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field.
batchIdstring
Filter results by batches of coupons
exactMatchboolean
Filter results to an exact case-insensitive matching against the coupon code.
Default false
dateFormatstring
Determines the format of dates in the export document.
One ofexcelISO8601
campaignStatestring
Filter results by the state of the campaign.
- `enabled`: Campaigns that are scheduled, running (activated), or expired.
- `running`: Campaigns that are running (activated).
- `disabled`: Campaigns that are disabled.
- `expired`: Campaigns that are expired.
- `archived`: Campaigns that are archived.
One ofenableddisabledarchivedscheduledrunningexpiredstaged
valuesOnlyboolean
Filter results to only return the coupon codes (`value` column) without the associated coupon data.
Default false
