List clients

GET

https://api-v2.test.eldowallet.fr/clients

Paginated list of the wallet's clients with the state of their loyalty card (passStatus, deviceTypes, shortLink). Combine full-text search (search), exact-match filters and the status filter to find a client or a segment.

Good to know

• firstName, lastName, email, barcode and phoneNumber are exact-match filters; use search for a partial, case-insensitive match. The status, createdAtStart and sort parameters apply to the client's loyalty card.

Request

query parameters

• sortOrder string
  Sort order: `asc` or `desc`. Default: `desc`.
  enum: asc, descdefault: "desc"
• status string[]
  Loyalty card status: `active`, `inactive`, `deleted`, `canceled` or `expired`. Repeat the parameter to combine several statuses.
• createdAtStart string <date-time>
  Only returns clients whose card was created on or after this date (ISO 8601).
• email string <email>
  Exact client email.
• barcode string
  Exact client barcode.
• phoneNumber string
  Exact client phone number, as stored.
• firstName string
  Exact first name (case-sensitive). For a partial match, use `search`.
• lastName string
  Exact last name (case-sensitive). For a partial match, use `search`.
• search string
  Case-insensitive partial match on first name, last name, email, barcode, phone number and client ID.
• sortBy string
  Loyalty card sort field: `createdAt` (default), `updatedAt`, `_id`, `status` or `expirationDate`. Any other value falls back to `createdAt`.
  default: "createdAt"
• limit number
  Clients 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

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

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