1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-11-25 22:12:29 +02:00
Files
OpenIntegrations/docs/en/md/Bitrix24/Users-management/Find-users.mdx
Vitaly the Alpaca (bot) 9be4b23629 Main build (Jenkins)
2025-10-31 15:42:42 +03:00

97 lines
2.9 KiB
Plaintext
Vendored

---
sidebar_position: 6
description: Find users and other functions to work with Bitrix24 in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI
keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI, Bitrix24]
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# 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 | Required | 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
<br/>
:::tip
Method at API documentation: [user.update](https://dev.1c-bitrix.ru/rest_help/users/user_update.php)
:::
<br/>
```bsl title="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 = "53100369006e9f06006b12e400000001000...";
FilterStructure = New Structure;
FilterStructure.Insert("UF_DEPARTMENT_NAME", "Bitrix");
Result = OPI_Bitrix24.FindUsers(URL, FilterStructure, Token);
```
<Tabs>
<TabItem value="bash" label="Bash" default>
```bash
# 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 "***"
```
</TabItem>
<TabItem value="bat" label="CMD/Bat" default>
```batch
:: 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 "***"
```
</TabItem>
</Tabs>
```json title="Result"
{
"result": [],
"time": {
"start": 1761911921,
"finish": 1761911921.94856,
"duration": 0.948556900024414,
"processing": 0,
"date_start": "2025-10-31T11:58:41+00:00",
"date_finish": "2025-10-31T11:58:41+00:00",
"operating_reset_at": 1761912521,
"operating": 0
}
}
```