user.search

Scope: user Права на выполнение: для всех

Перечень полей пользователей Битрикс24, который будет получен в результате выполнения метода, зависит от скоупа приложения/вебхука. Подробности о доступе к данным пользователей можно узнать в статье.

Метод для получения списка пользователей с ускоренным поиском по персональным данным (имя, фамилия, отчество, название подразделения, должность). Работает в двух режимах: быстро с помощью Fulltext Index и более медленный вариант через правый LIKE USER_NAME LIKE "Текст%" - это называется правый лайк, когда поиск осуществляется только по тексту который начинается на заданную фразу, но может содержать разные окончания - такой поиск существенно быстрее чем у двухстороннего лайка "%текст%" или левостороннего "%текст" - за счет архитектуры хранения идексированных полей в БД (поддержка определяется автоматически).

Параметры

Параметр	Описание	С версии
FILTER	Массив может содержать поля в любом сочетании: NAME - имя LAST_NAME - фамилия WORK_POSITION - должность UF_DEPARTMENT_NAME - название подразделения USER_TYPE - тип пользователя. Может принимать следующие значения: employee - сотрудник, extranet - пользователь экстранета, email - почтовый пользователь Или FIND - поле которое будет искать во всех перечисленных полях (Это аналог режима старого CUser::GetList в котором можно было задать фильтр NAME_SEARCH и получить результат) Метод может работать либо с фильтрацией с помощью ключа FIND или со всеми другими полями. Одновременно использовать FIND и любое другое поле - нельзя.

Параметр

Описание

С версии

FILTER

Массив может содержать поля в любом сочетании:

NAME - имя
LAST_NAME - фамилия
WORK_POSITION - должность
UF_DEPARTMENT_NAME - название подразделения
USER_TYPE - тип пользователя. Может принимать следующие значения:
employee - сотрудник,
extranet - пользователь экстранета,
email - почтовый пользователь

Или FIND - поле которое будет искать во всех перечисленных полях (Это аналог режима старого CUser::GetList в котором можно было задать фильтр NAME_SEARCH и получить результат)

Метод может работать либо с фильтрацией с помощью ключа FIND или со всеми другими полями. Одновременно использовать FIND и любое другое поле - нельзя.

Метод наследует поведение метода user.get все параметры из этой функции так же доступны.

Пример

Результат:

{
	"result": [
		{
			"ID": "2",
			"ACTIVE": true,
			"EMAIL": "m.ivshina@example.com",
			"NAME": "Мария",
			"LAST_NAME": "Ившина",
			"SECOND_NAME": "",
			"PERSONAL_GENDER": "F",
			"PERSONAL_PROFESSION": "",
			"PERSONAL_WWW": "http://shelenkov.com/horse/events.html",
			"PERSONAL_BIRTHDAY": "1984-04-29T02:00:00+04:00",
			"PERSONAL_PHOTO": "http://www.hazz/upload/main/982/42-17082203.gif",
			"PERSONAL_ICQ": "431-874-61",
			"PERSONAL_PHONE": "",
			"PERSONAL_FAX": "",
			"PERSONAL_MOBILE": "",
			"PERSONAL_PAGER": "",
			"PERSONAL_STREET": "",
			"PERSONAL_CITY": "",
			"PERSONAL_STATE": "",
			"PERSONAL_ZIP": "",
			"PERSONAL_COUNTRY": "0",
			"WORK_COMPANY": "",
			"WORK_POSITION": "IT-\"специалист\"",
			"WORK_PHONE": "+7 495 188 46 29",
			"UF_DEPARTMENT": [
				51,
				55,
				84
			],
			"UF_INTERESTS": null,
			"UF_SKILLS": null,
			"UF_WEB_SITES": null,
			"UF_XING": null,
			"UF_LINKEDIN": null,
			"UF_FACEBOOK": null,
			"UF_TWITTER": null,
			"UF_SKYPE": null,
			"UF_DISTRICT": null,
			"UF_PHONE_INNER": "4629"
		}
	],
	"total": 1
}