API

Get a list of client bonus transactions

GET/api/crm/v2/clients_bonusesv2
operationId: clientsBonuses.default

Authorization

api-token + language + role

Query parameters

page_numberinteger

Example: 1

date_creation_fromstring

Example: 25/04/2024

date_creation_tostring

Example: 26/04/2024

chain_idinteger

Example: 1

branch_idinteger
phone_format_idinteger

Example: 1

phone_numberstring

Example: 9999999999

genderstring

Values:womanman

downloadstring

Values:yes

Example: yes

Responses

OK

object
statusstringrequired

Values:successerror

Example: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringcan be null

Example: 2026-08-01 00:00:00

typestringrequired

Example: date

modestring (FilterMode)

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

date_creation_toobject (FilterDateTo)
valuestringcan be null

Example: 2026-08-31 23:59:59

typestringrequired

Example: date

modestring (FilterMode)

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

date_creation_rangeobject (FilterDateRange)

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.

valuestring (DateRange) can be null

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

defaultstring (DateRange) 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

typestringrequired

Example: select

modestring (FilterMode)

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

optionarray of objectrequired
valuestring (DateRange) 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

date_fromstringrequired

Example: 25/08/2026

branch_idobject (FilterSelectInteger)
valueinteger

Example: 8920

typestringrequired

Example: select

optionarray of object
valueintegerrequired

Example: 8920

namestringrequired

Example: Green Basket | Kaliningrad

modestring (FilterMode)

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

phone_format_idobject (FilterSelectInteger)
valueinteger

Example: 8920

typestringrequired

Example: select

optionarray of object
valueintegerrequired

Example: 8920

namestringrequired

Example: Green Basket | Kaliningrad

modestring (FilterMode)

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

phone_numberobject (FilterInput)
valuestring

Example: example

typestringrequired

Example: integer or string

placeholderstring

Example: string

modestring (FilterMode)

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

genderobject (FilterEnum)

Filter enumeration — a flat list of enumeration values

valuestring

Example: example

typestringrequired

Example: select

optionarray of string
modestring (FilterMode)

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

downloadobject (FilterButtonDownloadCsv)

Download selection button: on click, pass download=yes

valuestring

Example: Download

typestringrequired

Example: button_download_csv

system_automationboolean

Example: true

listarray of object
idintegerrequired

Example: 1

date_creationstring (DataTimeFormatSQL) required

Example: 2024-05-02 08:31:16

date_availablestring (DataTimeFormatSQL)

Example: 2024-05-02 08:31:16

date_expirationstring (DataTimeFormatSQL)

Example: 2024-05-02 08:31:16

date_changestring (DataTimeFormatSQL)

Example: 2024-05-02 08:31:16

typestringrequired

Values:birthdayfeedbackpromo_coderegistrationinvitationreferral_codereferralordergift

Example: gift

descriptionstring

Example: bonuses for the registration

sumnumberrequired

Example: 135

order_idinteger

Example: 0

feedback_idinteger

Example: 0

statusstringrequired

Values:availablenot_available

Example: available

branch_idinteger

Example: 1

order_numberinteger

Example: 1

feedback_datestring (DataTimeFormatSQL)

Example: 2024-05-02 08:31:16

client_namestring

Example: client name

client_phone_format_idinteger

Example: 1

client_phone_numberstring

Example: 9638887321

chain_namestring

Example: Green Basket

spent_sumnumberrequired

Example: 135

paginationobject (Pagination)
max_countintegerrequired

Number of items per page

Example: 30

page_numberintegerrequired

Current page number; limited so that the offset does not exceed 1000

Example: 1

has_nextbooleanrequired

Is there a next page

Example: true

has_previousbooleanrequired

Is there a previous page

Example: false