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