List the coupons of a template

GET

https://api-v2.test.eldowallet.fr/coupons/:id/passes

Returns the paginated list of coupons sent from a template. By default, only coupons with status active or expired are returned, newest first.

Good to know

• Without status, only active and expired coupons are returned. Deleted coupons are erased permanently and never appear in this list.

Request

path parameters

• id string required
  Coupon template ID.

query parameters

• sortOrder string
  Sort order: `asc` (ascending) or `desc` (descending). Default: `desc`.
  enum: asc, descdefault: "desc"
• status object
  Coupon status: `active`, `inactive`, `deleted`, `canceled` or `expired`. Repeat the parameter to filter on several statuses. Default: `active` and `expired`.
• createdAtStart string
  Only return coupons created on or after this date (ISO 8601, inclusive).
• search string
  Partial, case-insensitive search in `firstName`, `lastName`, `email` and `barcode`, and in the coupon ID and client ID.
• sortBy string
  Field to sort by. Default: `createdAt`.
  default: "createdAt"
• limit number
  Number of results per page, from 1 to 1000. Default: 10.
  default: 10min: 1max: 1000
• page number
  Page number to return, starting at 1. Default: 1.
  default: 1min: 1

header parameters

• x-lang string
  Language for responses
  enum: en, frdefault: "en"

Responses

200

Schema application/json

• docs object[] required
• totalDocs number required
• limit number required
• page number
• totalPages number required
• pagingCounter number required
• hasPrevPage boolean required
• hasNextPage boolean required
• prevPage number
• nextPage number

400

INVALID_PASS_KIND

Schema application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

401

UNAUTHORIZED

Schema application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

403

FORBIDDEN

Schema application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

404

MODEL_NOT_FOUND

Schema application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

500

UNKNOWN_ERROR

Schema application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email