API

Отримати список користувачів або одного користувача

GET/api/crm/v2/teamv2
operationId: team.default

Без id повертає посторінковий список користувачів зі скороченими записами. З id у data.list[0] повертається повний запис користувача, без пагінації та фільтрів. Режим (partner або affiliate) встановлюється сервером за сесією. Фільтр за роллю (permission_role_id) та пошук за ім'ям (name) не є обов'язковими.

Авторизація

api-token + language + role

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

idinteger

Якщо передано, повертається один повний запис без пагінації

Приклад: 1

permission_role_idinteger

Приклад: 1

namestring

Усі режими; підрядок імені користувача (ім'я та прізвище) без урахування регістру

Приклад: Alina

page_numberinteger

Приклад: 1

Відповіді

OK

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

Значення:successerror

Приклад: success

dataobject
filtersobject
modeobject (FilterSelect)
valuestring

Приклад: example

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

Приклад: select

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

Приклад: example

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

Приклад: All

modestring (FilterMode)

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

Значення:force_shownvalue_required

Приклад: value_required

account_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

affiliate_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

permission_role_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

nameobject (FilterInput)
valuestring

Приклад: example

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

Приклад: integer or string

placeholderstring

Приклад: string

modestring (FilterMode)

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

Значення:force_shownvalue_required

Приклад: value_required

listarray of oneOf
oneOf
Один із варіантів
object (PermissionRoleUserPartner)

Користувач у режимі partner

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

Приклад: 1

namestring

Приклад: John Doe

emailstring

Приклад: user@example.com

photostring

Приклад: data:image/jpeg;base64,/9j/4AAQSkZJRg...

permission_rolesarray of objectобов’язковий

Усі ролі користувача, відсортовані за id ролі

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

Приклад: 5

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

Назва ролі з довідника ролей; набір значень відкритий

Приклад: head_of_sales

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

Стан перемикача блокування

Приклад: false

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

date_creationstring (DataTimeFormatSQL)

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

bound_settingsarray of string

Налаштування, пов’язані з користувачем, для попередження при видаленні; null, якщо відсутні

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

Перемикач блокування доступний у цьому рядку для поточного користувача; правило визначає сервер, не виводьте його з назв ролей

Приклад: true

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

Поточний користувач може переглядати та закривати сесії цього рядка

Приклад: false

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

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

Приклад: 30

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

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

Приклад: 1

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

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

Приклад: true

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

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

Приклад: false