Lister les passes d'un événement

GET

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

Renvoie la liste paginée des passes émis pour un événement, avec filtres par statut et date de création, et recherche texte.

À retenir

• Sans status, les passes de tous statuts sont renvoyés. Pour un pass rattaché à un client, firstName, lastName, email et phoneNumber reflètent les données actuelles du client.

Requête

path parameters

• id string required
  Identifiant de l'événement (ID MongoDB de 24 caractères hexadécimaux).

query parameters

• sortOrder string
  Ordre de tri : `asc` ou `desc`. Défaut : `desc`.
  enum: asc, descdefault: "desc"
• status object
  Filtre par statut du pass : `active`, `inactive`, `deleted`, `canceled` ou `expired`. Répétez le paramètre pour filtrer sur plusieurs statuts.
• createdAtStart string
  Ne renvoie que les éléments créés à partir de cette date (ISO 8601, incluse).
• search string
  Recherche insensible à la casse sur `firstName`, `lastName`, `email`, `barcode`, l'identifiant du pass ou celui du client.
• sortBy string
  Champ de tri. Défaut : `createdAt`.
  default: "createdAt"
• limit number
  Nombre d'éléments par page, de 1 à 1000. Défaut : `10`.
  default: 10min: 1max: 1000
• page number
  Numéro de page, à partir de 1. Défaut : `1`.
  default: 1min: 1

header parameters

• x-lang string
  Langue des messages d'erreur et des textes renvoyés : `fr` ou `en`.
  enum: en, frdefault: "en"

Réponses

200

Schéma 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

Schéma 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

Schéma 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

Schéma 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

Schéma 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

Schéma 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