Documentation

user.get

Scope: catalog Permissions to execute: for all

This method does not return integrators. List of Bitrix24 user fields to be retrieved as the result of executed method depends on application/webhook scope. Method follows the general rule for page navigation - prints 50 entries by default. Find more details on access to user data in this article.

Description

Retrieves filtered list of users. This method will return all users, except: bots, users for e-mail and users for Open Channels.

Call

BX24.callMethod('user.get', {"ID": 1});

Request

https://my.bitrix24.com/rest/user.get.json?ID=1&auth=b961afd4148963c5d54ebeb17123d1fc

Response

{"result":[{"ID":"1","ACTIVE":true,"EMAIL":"sigurd@example.com","NAME":"Administrator","LAST_NAME":"","SECOND_NAME":"","PERSONAL_GENDER":"","PERSONAL_PROFESSION":"","PERSONAL_WWW":"","PERSONAL_BIRTHDAY":"1955-04-10T00:00:00+03:00","PERSONAL_PHOTO":"\/upload\/main\/80c\/44169_C5_PrimalWaterE500CC.jpg","PERSONAL_ICQ":"","PERSONAL_PHONE":"","PERSONAL_FAX":"","PERSONAL_MOBILE":"","PERSONAL_PAGER":"","PERSONAL_STREET":"","PERSONAL_CITY":"","PERSONAL_STATE":"","PERSONAL_ZIP":"","PERSONAL_COUNTRY":"0","WORK_COMPANY":"","WORK_POSITION":"","UF_DEPARTMENT":[128],"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":null}],"total":1}


Parameters

ParameterDescription
sortfield, by which the results are sorted
order sorting direction
  • ASC - by ascension.
  • DESC - by descension
FILTERAdditionally, any parameters from user.fields can be specified for filtering by their values. Aside from main fields, the following additional fields are available:
  • UF_DEPARTMENT - membership in company structure;
  • UF_PHONE_INNER - internal phone number;
  • IS_ONLINE - Y/N - allows to show only authorized or non-authorized users.
  • NAME_SEARCH - quick search by personal data.
  • USER_TYPE - user type. Can have the following values:
    employee - employee,
    extranet - extranet user,
    email - user of email
  • ACTIVE - when true excludes dismissed employees from query.

Filtration parameters can assume values of arrays.

ADMIN_MODEKey, enabling the admin mode. Designed to retrieve data about any users.

© «Bitrix24», 2001-2024