API Reference

Get all vouchers

get
https://{project_url}/webservice/rest-api/{api_interface}/{version}/vouchers

Get information as a list of all vouchers.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1
Defaults to 100

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.

integer
≥ 0
Defaults to 0

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

string

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.

string
enum

Direction of sorting the response list.

Allowed:
string

The unique ID of the customer.

string

Unique code of the voucher.

string

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

boolean
enum

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

Allowed:
boolean
enum

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

Allowed:
boolean
enum

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

Allowed:
string

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

boolean
enum

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.

Allowed:
Headers
string
Defaults to cs, en-gb;q=0.8

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

Responses

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Updated 5 months ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago