Find coupon lists

Prev Next
Get
/couponList/find

Metadata, reminder settings and code availability counts only. Counts include outstanding sendout reservations as locked. Pages start at 1; pageSize defaults to 25 and is limited to 500. couponListName is an optional case-insensitive substring filter. Archived is optional and defaults to false (active lists only). Set archived to true for archived lists only. No real coupon code values are returned by this endpoint.

Query parameters
couponListName
string

Optional case-insensitive substring of the list name; maximum 50 characters.

archived
boolean

Return archived lists when true; active lists otherwise.

Defaultfalse
page
integer (int32)

Page number, starting at 1.

Minimum1.0
Default1
pageSize
integer (int32)

Maximum number of lists per page (1-500).

Minimum1.0
Maximum500.0
Default25
Responses
200

A page of coupon list metadata and code counts.

Array of object
object
id
integer (int64)
name
string
description
string
previewText
string
defaultText
string
archived
boolean
Defaultfalse
updated
integer (int64)
counts
object (CouponCodeSummary)
free
integer (int64)
locked
integer (int64)
total
integer (int64)
reminderEnabled
boolean
Defaultfalse
remindThreshold
integer (int64)
additionalReminderEmail
string
400

InvalidParameterException / INVALID_PARAMETER: couponListName exceeds 50 characters, page is below 1, pageSize is outside 1-500, or the requested page exceeds the supported offset range.
UnexpectedErrorException / PERMISSION_DENIED: caller lacks coupon list read permissions. View/edit-own permission restricts results to lists owned by the caller.

object
errorActor
string
errorCode
string
message
string
500

UnexpectedErrorException / UNEXPECTED_ERROR: a backend operation failed; errorActor is SERVER.

object
errorActor
string
errorCode
string
message
string