List communications

GET

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

Paginated list of the wallet's communications, filterable by status, by start-date range and by a text search on the description.

Good to know

• Statuses: PENDING (waiting for startDate), ACTIVE (live on the loyalty card), INACTIF (deactivated), EXPIRED (endDate passed). Activation at startDate and expiry at endDate are handled automatically.

Request

query parameters

• sortOrder string
  Sort direction: `ASC` or `DESC`. Default: `DESC`.
  enum: asc, descdefault: "desc"
• status string
  Filter by status: `PENDING`, `ACTIVE`, `INACTIF` or `EXPIRED`.
  enum: PENDING, ACTIVE, INACTIF, EXPIRED
• startDateStart string
  Only return communications whose `startDate` is on or after this date (ISO 8601).
• startDateEnd string
  Only return communications whose `startDate` is on or before this date (ISO 8601).
• search string
  Case-insensitive search in the communication's `description` or ID.
• sortBy string
  Sort field. Default: `createdAt`.
  default: "createdAt"
• limit number
  Items per page, from 1 to 1,000. 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