API

Отримати список акаунтів клієнтів

GET/api/crm/v2/clients_accountsv2
operationId: clientsAccounts.default

Авторизація

api-token + language + role

Параметри запиту

page_numberinteger

Приклад: 1

date_fromstring

Приклад: 25/04/2024

date_tostring

Приклад: 26/04/2024

date_first_order_fromstring

Приклад: 26/04/2024

date_first_order_tostring

Приклад: 26/04/2024

date_last_order_fromstring

Приклад: 26/04/2024

date_last_order_tostring

Приклад: 26/04/2024

chain_idinteger

Приклад: 1

phone_format_idinteger

Приклад: 1

phone_numberstring

Приклад: 9999999999

count_ordersinteger

Приклад: 2

genderstring

Значення:womanman

client_branch_profile_idinteger
client_account_idinteger
downloadstring

Передайте yes, щоб завантажити вибірку файлом CSV

Значення:yes

Приклад: yes

Відповіді

OK

object
statusstringобов’язковий

Значення:successerror

Приклад: success

dataobject
filtersobject
date_fromobject (FilterDateFrom)
valuestringможе бути null

Приклад: 2026-08-01 00:00:00

typestringобов’язковий

Приклад: date

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

date_toobject (FilterDateTo)
valuestringможе бути null

Приклад: 2026-08-31 23:59:59

typestringобов’язковий

Приклад: date

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

date_first_order_fromobject (FilterDateTo)
valuestringможе бути null

Приклад: 2026-08-31 23:59:59

typestringобов’язковий

Приклад: date

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

date_first_order_toobject (FilterDateTo)
valuestringможе бути null

Приклад: 2026-08-31 23:59:59

typestringобов’язковий

Приклад: date

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

date_last_order_fromobject (FilterDateTo)
valuestringможе бути null

Приклад: 2026-08-31 23:59:59

typestringобов’язковий

Приклад: date

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

date_last_order_toobject (FilterDateTo)
valuestringможе бути null

Приклад: 2026-08-31 23:59:59

typestringобов’язковий

Приклад: date

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

date_of_birth_fromobject (FilterDateFrom)
valuestringможе бути null

Приклад: 2026-08-01 00:00:00

typestringобов’язковий

Приклад: date

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

date_of_birth_toobject (FilterDateTo)
valuestringможе бути null

Приклад: 2026-08-31 23:59:59

typestringобов’язковий

Приклад: date

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

phone_format_idobject (FilterSelectInteger)
valueinteger

Приклад: 8920

typestringобов’язковий

Приклад: select

optionarray of object
valueintegerобов’язковий

Приклад: 8920

namestringобов’язковий

Приклад: Green Basket | Kaliningrad

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

phone_numberobject (FilterInput)
valuestring

Приклад: example

typestringобов’язковий

Приклад: integer or string

placeholderstring

Приклад: string

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

count_ordersobject (FilterInput)
valuestring

Приклад: example

typestringобов’язковий

Приклад: integer or string

placeholderstring

Приклад: string

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

genderobject (FilterEnum)

Фільтр-перерахування — плоский список значень перерахування

valuestring

Приклад: example

typestringобов’язковий

Приклад: select

optionarray of string
modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

client_branch_profile_idobject (FilterId)
valueany

Приклад: 0

typestringобов’язковий

Приклад: integer

placeholderstring

Приклад: integer

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

client_account_idobject (FilterId)
valueany

Приклад: 0

typestringобов’язковий

Приклад: integer

placeholderstring

Приклад: integer

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

downloadobject (FilterButtonDownloadCsv)

Кнопка завантаження вибірки: при натисканні передайте download=yes

valuestring

Приклад: Download

typestringобов’язковий

Приклад: button_download_csv

system_automationboolean

Приклад: true

listarray of object
idintegerобов’язковий

Приклад: 1

datestring (DataTimeFormatSQL) обов’язковий

Приклад: 2024-05-02 08:31:16

client_account_idintegerобов’язковий

Приклад: 1

namestringобов’язковий

Приклад: client name

phone_format_idinteger (PhoneFormatId)

Код країни: 1-🇷🇺(+7|8), 2-🇦🇿(+994|0), 3-🇧🇾(+375|80), 4-🇰🇿(+7|8), 6-🇷🇸(+381|0), 7-🇹🇷(+90|0), 8-🇺🇦(+380|0), 9-🇵🇹(+351|0), 10-🇰🇬(+996|0), 11-🇺🇸(+1), 12-🇫🇷(+33|0), 13-🇲🇩(+373|0), 15-🇪🇪(+372), 18-🇬🇪(+995), 19-🇺🇿(+998), 22-🇵🇱(+48|0), 23-🇹🇯(+992|8), 25-🇷🇴(+40|0), 44-🇨🇭(+41|0)

Приклад: 1

phone_numberstring

Приклад: 9999999999

genderstring

Значення:womanman

Приклад: man

date_of_birthstring

Приклад: 1982-01-03

date_change_date_of_birthstring

Приклад: 2024-07-05

referral_codestring

Приклад: example

chain_idinteger

Приклад: 1

bonusesinteger

Приклад: 1

count_ordersinteger

Приклад: 3

sum_ordersnumber

Приклад: 1000

date_last_orderstring (DataTimeFormatSQL)

Приклад: 2024-05-02 08:31:16

date_first_orderstring (DataTimeFormatSQL)

Приклад: 2024-05-02 08:31:16

special_offersarray of object
datestring (DataTimeFormatSQL) обов’язковий

Приклад: 2024-05-02 08:31:16

special_offer_idintegerобов’язковий

Приклад: 1

special_offer_namestringобов’язковий

Приклад: -10% on pickup

special_offer_promo_code_idinteger

Приклад: 1

promo_codestring

Приклад: FREE10

paginationobject (Pagination)
max_countintegerобов’язковий

Кількість елементів на сторінці

Приклад: 30

page_numberintegerобов’язковий

Номер поточноï сторінки; обмежено так, щоб зсув не перевищував 1000

Приклад: 1

has_nextbooleanобов’язковий

Чи є наступна сторінка

Приклад: true

has_previousbooleanобов’язковий

Чи є попередня сторінка

Приклад: false