List coupons
GET {{baseUrl}}/v1/applications/:applicationId/campaigns/:campaignId/coupons/no_total?pageSize=1000&skip=10&sort=value&value=value&createdBefore=2022-11-08T00:11:22.082Z&createdAfter=2022-11-08T00:11:22.082Z&valid=expired&usable=false&referralId=10&recipientIntegrationId=value&batchId=value&exactMatch=false&expiresBefore=2022-11-08T00:11:22.082Z&expiresAfter=2022-11-08T00:11:22.082Z&startsBefore=2022-11-08T00:11:22.082Z&startsAfter=2022-11-08T00:11:22.082Z&valuesOnly=false
List all the coupons matching the specified criteria.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
pageSize | number | The number of items in this response. | |
skip | number | The number of items to skip when paging through large result sets. | |
sort | string | 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: This parameter works only with numeric fields.
|
| value | string | | 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. |
| createdBefore | string | | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. |
| createdAfter | string | | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. |
| valid | string | | 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.
|
| usable | boolean | | Either "true" or "false". If "true", only coupons where usageCounter < usageLimit will be returned, "false" will return only coupons where usageCounter >= usageLimit.
|
| referralId | number | | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. |
| recipientIntegrationId | string | | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field |
| batchId | string | | Filter results by batches of coupons |
| exactMatch | boolean | | Filter results to an exact case-insensitive matching against the coupon code |
| expiresBefore | string | | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. |
| expiresAfter | string | | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. |
| startsBefore | string | | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. |
| startsAfter | string | | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. |
| valuesOnly | boolean | | Filter results to only return the coupon codes (value column) without the associated coupon data. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |