Skip to main content

Find users

Gets the list of users according to the specified filter

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

ParameterCLI optionTypeRequiredDescription
URL--urlString✔URL of webhook or a Bitrix24 domain, when token used
FilterStructure--filterStructure Of KeyAndValue✔Filter. See GetUserFilterStructure
Token--tokenString✖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


1C:Enterprise/OneScript code example
    URL = "https://b24-ar17wx.bitrix24.by/rest/1/h0m...";

    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 = "8a1bee68006e9f06006b12e400000001000...";

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

    Result = OPI_Bitrix24.FindUsers(URL, FilterStructure, Token);
    # JSON data can also be passed as a path to a .json file
    
    oint bitrix24 FindUsers \
     --url "b24-ar17wx.bitrix24.by" \
     --filter "{'UF_DEPARTMENT_NAME':'Bitrix'}" \
     --token "***"
Result
{
 "result": [],
 "time": {
  "start": 1760522543,
  "finish": 1760522543.7487,
  "duration": 0.748697996139526,
  "processing": 0,
  "date_start": "2025-10-15T10:02:23+00:00",
  "date_finish": "2025-10-15T10:02:23+00:00",
  "operating_reset_at": 1760523143,
  "operating": 0
 }
}