Get a list of client bonus transactions
/api/crm/v2/clients_bonusesv2clientsBonuses.defaultAuthorization
api-token + language + role
Query parameters
Example: 1
Example: 25/04/2024
Example: 26/04/2024
Example: 1
Example: 1
Example: 9999999999
Values:womanman
Values:yes
Example: yes
Responses
OK
Values:successerror
Example: success
Example: 2026-08-01 00:00:00
Example: date
How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.
Values:force_shownvalue_required
Example: value_required
Example: 2026-08-31 23:59:59
Example: date
How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.
Values:force_shownvalue_required
Example: value_required
Predefined date filter ranges; the lower boundary is calculated in the user's timezone. value is the range corresponding to the current *_from and *_to; null means a custom range. default is the range the server uses when a request has no dates: it is also applied on the first section load and when resetting. The upper boundary of the range always matches the user's current day, so option does not include it: you do not need to send *_to for a predefined range, the server sets it automatically. Ranges longer than one year are trimmed from the most recent boundary.
Predefined date filter range. It does not have its own query parameter: the lower boundary is pre-calculated in option and is used as *_from. The upper boundary is neither returned in the response nor sent in the request—it is always set to the user's current day by the server.
Values:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear
Example: today
Predefined date filter range. It does not have its own query parameter: the lower boundary is pre-calculated in option and is used as *_from. The upper boundary is neither returned in the response nor sent in the request—it is always set to the user's current day by the server.
Values:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear
Example: today
Example: select
How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.
Values:force_shownvalue_required
Example: value_required
Predefined date filter range. It does not have its own query parameter: the lower boundary is pre-calculated in option and is used as *_from. The upper boundary is neither returned in the response nor sent in the request—it is always set to the user's current day by the server.
Values:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear
Example: today
Example: 25/08/2026
Example: 8920
Example: select
Example: 8920
Example: Green Basket | Kaliningrad
How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.
Values:force_shownvalue_required
Example: value_required
Example: 8920
Example: select
Example: 8920
Example: Green Basket | Kaliningrad
How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.
Values:force_shownvalue_required
Example: value_required
Example: example
Example: integer or string
Example: string
How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.
Values:force_shownvalue_required
Example: value_required
Filter enumeration — a flat list of enumeration values
Example: example
Example: select
How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.
Values:force_shownvalue_required
Example: value_required
Download selection button: on click, pass download=yes
Example: Download
Example: button_download_csv
Example: true
Example: 1
Example: 2024-05-02 08:31:16
Example: 2024-05-02 08:31:16
Example: 2024-05-02 08:31:16
Example: 2024-05-02 08:31:16
Values:birthdayfeedbackpromo_coderegistrationinvitationreferral_codereferralordergift
Example: gift
Example: bonuses for the registration
Example: 135
Example: 0
Example: 0
Values:availablenot_available
Example: available
Example: 1
Example: 1
Example: 2024-05-02 08:31:16
Example: client name
Example: 1
Example: 9638887321
Example: Green Basket
Example: 135
Number of items per page
Example: 30
Current page number; limited so that the offset does not exceed 1000
Example: 1
Is there a next page
Example: true
Is there a previous page
Example: false