OpenIntegrations/docs/en/md/Bitrix24/Users-managment/Find-users.md

sidebar_position

sidebar_position
6

Find users

Gets the list of users according to the specified filter

Function FindUsers(Val URL, Val FilterStructure, Val Token = "") Export

Parameter	CLI option	Type	Description
URL	--url	String	URL of webhook or a Bitrix24 domain, when token used
FilterStructure	--filter	Structure of KeyAndValue	Filter. See GetUserFilterStructure
Token	--token	String	Access token, when app auth method used

Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API

:::tip Method at API documentation: user.update :::

    URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";

    FilterStructure = New Structure;
    FilterStructure.Insert("NAME"              , "Vitaly");
    FilterStructure.Insert("LAST_NAME"         , "Alpaca");
    FilterStructure.Insert("WORK_POSITION"     , "DevOps engineer");
    FilterStructure.Insert("UF_DEPARTMENT_NAME", "Marketing department");
    FilterStructure.Insert("USER_TYPE"         , "employee");

    Result = OPI_Bitrix24.FindUsers(URL, FilterStructure);

    URL   = "b24-ar17wx.bitrix24.by";
    Token = "37d1fe66006e9f06006b12e400000001000...";

    FilterStructure = New Structure;
    FilterStructure.Insert("UF_DEPARTMENT_NAME", "Bitrix");

    Result = OPI_Bitrix24.FindUsers(URL, FilterStructure, Token);

    
  oint bitrix24 FindUsers --url "b24-ar17wx.bitrix24.by" --filter %filter% --token "fe3fa966006e9f06006b12e400000001000..."

{
  "result": [
  {
  "ID": "12",
  "XML_ID": "56479740",
  "ACTIVE": true,
  "NAME": "Bay",
  "LAST_NAME": "Selonarrend",
  "EMAIL": "oarismos@gmail.com",
  "LAST_LOGIN": "2024-07-13T07:17:17+00:00",
  "DATE_REGISTER": "2024-07-13T00:00:00+00:00",
  "IS_ONLINE": "N",
  "TIMESTAMP_X": {},
  "LAST_ACTIVITY_DATE": {},
  "PERSONAL_GENDER": "",
  "PERSONAL_BIRTHDAY": "",
  "UF_EMPLOYMENT_DATE": "",
  "UF_DEPARTMENT": [
  1
  ],
  "USER_TYPE": "employee"
  },
  {
  "ID": "18",
  "XML_ID": "56701916",
  "ACTIVE": true,
  "EMAIL": "hey@exepmple.com",
  "LAST_LOGIN": "",
  "DATE_REGISTER": "2024-07-28T00:00:00+00:00",
  "IS_ONLINE": "N",
  "TIMESTAMP_X": {},
  "PERSONAL_GENDER": "",
  "PERSONAL_BIRTHDAY": "",
  "UF_EMPLOYMENT_DATE": "",
  "UF_DEPARTMENT": [
  1
  ],
  "USER_TYPE": "employee"
  },
  {
  "ID": "34",
  "XML_ID": "56702240",
  "ACTIVE": false,
  "EMAIL": "537fafa9-e5ea-4221-bd46-4f6db2609634@exepmple.org",
  "LAST_LOGIN": "",
  "DATE_REGISTER": "2024-07-28T00:00:00+00:00",
  "IS_ONLINE": "N",
  "TIMESTAMP_X": {},
  "PERSONAL_GENDER": "",
  "PERSONAL_BIRTHDAY": "",
  "UF_EMPLOYMENT_DATE": "",
  "UF_DEPARTMENT": [
  1
  ],
  "USER_TYPE": "employee"
  },
  {
  "ID": "38",
  "XML_ID": "56702244",
  "ACTIVE": false,
  "EMAIL": "442145e1-75e4-4c85-ac6d-e4da44c859a8@exepmple.org",
  "LAST_LOGIN": "",
  "DATE_REGISTER": "2024-07-28T00:00:00+00:00",
  "IS_ONLINE": "N",
  "TIMESTAMP_X": {},
  "PERSONAL_GENDER": "",
  "PERSONAL_BIRTHDAY": "",
  "UF_EMPLOYMENT_DATE": "",
  "UF_DEPARTMENT": [
  1
  ],
  "USER_TYPE": "employee"
  },
  {
  "ID": "42",
  "XML_ID": "56702314",
  "ACTIVE": true,
  "EMAIL": "3f70caee-2203-46ec-b53c-24f1c7092056@exepmple.org",
  "LAST_LOGIN": "",
  "DATE_REGISTER": "2024-07-28T00:00:00+00:00",
  "IS_ONLINE": "N",
  "TIMESTAMP_X": {},
  "PERSONAL_GENDER": "",
  "PERSONAL_BIRTHDAY": "",
  "UF_EMPLOYMENT_DATE": "",
  "UF_DEPARTMENT": [
  1
  ],
  "USER_TYPE": "employee"
  },
  {
  "ID": "46",
  "XML_ID": "56702336",
  "ACTIVE": false,
  "EMAIL": "f23e7d22-016d-4711-aa0f-439951951f35@exepmple.org",
  "LAST_LOGIN": "",
  "DATE_REGISTER": "2024-07-28T00:00:00+00:00",
  "IS_ONLINE": "N",
  "TIMESTAMP_X": {},
  "PERSONAL_GENDER": "",
  "PERSONAL_BIRTHDAY": "",
  "UF_EMPLOYMENT_DATE": "",
  "UF_DEPARTMENT": [
  1
  ],
  "USER_TYPE": "employee"
  },
  {
  "ID": "50",
  "XML_ID": "56702654",
  "ACTIVE": false,
  "EMAIL": "360bd8ae-146c-497b-ae87-0699855f21b7@exepmple.org",
  "LAST_LOGIN": "",
  "DATE_REGISTER": "2024-07-28T00:00:00+00:00",
  "IS_ONLINE": "N",
  "TIMESTAMP_X": {},
  "PERSONAL_GENDER": "",
  "PERSONAL_BIRTHDAY": "",
  "UF_EMPLOYMENT_DATE": "",
  "UF_DEPARTMENT": [
  1
  ],
  "USER_TYPE": "employee"
  },
  {
  "ID": "54",
  "XML_ID": "56721830",
  "ACTIVE": false,
  "EMAIL": "15ea8982-762a-44a0-9c53-c97530015c46@exepmple.org",
  "LAST_LOGIN": "",
  "DATE_REGISTER": "2024-07-29T00:00:00+00:00",
  "IS_ONLINE": "N",
  "TIMESTAMP_X": {},
  "PERSONAL_GENDER": "",
  "PERSONAL_BIRTHDAY": "",
  "UF_EMPLOYMENT_DATE": "",
  "UF_DEPARTMENT": [
  1
  ],
  "USER_TYPE": "employee"
  },
  {
  "ID": "1",
  "XML_ID": "53818298",
  "ACTIVE": true,
  "NAME": "Anton",
  "LAST_NAME": "Titovets",
  "EMAIL": "no-reply@bitrix24.com",
  "LAST_LOGIN": "2024-07-30T06:49:41+00:00",
  "DATE_REGISTER": "2024-02-10T00:00:00+00:00",
...