List the passes of a hotel

GET

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

Returns the paginated list of the booking passes issued for a hotel, with filters on status and creation date, and a text search.

Good to know

• Without status, passes of every status are returned, including canceled bookings (canceled). For a pass linked to a client, firstName, lastName, email and phoneNumber show the client's current data.

Request

path parameters

• id string required
  Hotel ID (24-character hexadecimal MongoDB ID).

query parameters

• sortOrder string
  Sort order: `asc` or `desc`. Default: `desc`.
  enum: asc, descdefault: "desc"
• status object
  Filter by pass status: `active`, `inactive`, `deleted`, `canceled` or `expired`. Repeat the parameter to filter on several statuses.
• createdAtStart string
  Only returns items created on or after this date (ISO 8601, inclusive).
• search string
  Case-insensitive search on `firstName`, `lastName`, `email`, `barcode`, the pass ID or the client ID.
• sortBy string
  Field to sort by. Default: `createdAt`.
  default: "createdAt"
• limit number
  Number of items per page, from 1 to 1000. Default: `10`.
  default: 10min: 1max: 1000
• page number
  Page number, 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