Get all vouchers

The number of records to return in API response.

⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.

The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.

Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.

Direction of sorting the response list.

The unique ID of the customer. GET /customers

Unique code of the voucher.

The unique ID of the store where customer can apply the reward. GET /stores

in validity range - true / before or after validity range - false / no value - all

Filter by voucher application and reservation. Possible values: true - all applied or reserved vouchers / false - all vouchers that have not been applied yet or that are not reserved actually / no value - all vouchers

If true or not set, the data will not contain information about business units (stores). If false resource returns full structure with stores.

The unique ID of the reward in CareCloud. GET /rewards In case you want to filter multiple options use array syntax : reward_id[]=8bc8ca16f9c5039951021700a2&reward_id[]=82c06812c0756528660784fef

If true, the response includes service vouchers alongside standard vouchers. Service vouchers are internal records used for history tracking (for example, vouchers with codes beginning with canceled_ or initial_). If false or not set, service vouchers are excluded from the response.

The unique ID of the language code by ISO 639-1.