API

Отримати чорний список

GET/api/crm/v2/black_listv2
operationId: blackList.default

Авторизація

api-token + language + role

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

page_numberinteger

Приклад: 1

phone_format_idinteger

Приклад: 1

phone_numberstring

Приклад: (707) 712-51-19

Відповіді

OK

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

Значення:successerror

Приклад: success

dataobject
filtersobject
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

idobject (FilterId)
valueany

Приклад: 0

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

Приклад: integer

placeholderstring

Приклад: integer

modestring (FilterMode)

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

Значення:force_shownvalue_required

Приклад: value_required

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

Приклад: 82348

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

Приклад: 17:45 06/05/2024

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

Приклад: 7143

client_account_idinteger

Приклад: 0

client_branch_profile_idinteger

Приклад: 0

phone_format_idinteger

Приклад: 4

phone_numberstring

Приклад: 7077125119

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

Приклад: true

client_namestring

Приклад: example

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

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

Приклад: 30

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

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

Приклад: 1

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

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

Приклад: true

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

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

Приклад: false