bx24_users
Handle Bitrix24 user operations: get current or specific users, search by filter, list by department, manage custom user fields, and create, update, or delete user accounts.
Instructions
Bitrix24 portal users: current, get, search, list by department, user fields, user CRUD. Methods user., user.userfield. (REST 1.0 + 3.0). RU/EN: пользователь, кто я, найти сотрудника, отдел, пригласить / user, who am i, find user, invite.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ID | No | User ID (single or array for user.get) | |
| order | No | Order object (e.g. { 'ID': 'DESC' }) | |
| start | No | Pagination offset (number of records to skip) | |
| FILTER | No | Search/filter: NAME, LAST_NAME, EMAIL, UF_DEPARTMENT, ACTIVE | |
| action | Yes | Operation to perform: - "current": Get the current authenticated user - "get": Get user(s) by ID - "listByDepartment": List users of a department (pass department user IDs via ID) - "search": Search users (FILTER: NAME/EMAIL/UF_DEPARTMENT/ACTIVE) - "fields": Describe user fields - "userfield_get": Get a custom user field - "userfield_list": List custom user fields - "userfield_add": Create a custom user field - "userfield_update": Update a custom user field - "userfield_delete": Delete a custom user field (destructive) - "add": Invite/add a new user (destructive — creates account) - "update": Update a user - "delete": Delete a user (destructive) | |
| fields | No | User fields: NAME, LAST_NAME, EMAIL, ACTIVE, UF_DEPARTMENT_ID, PERSONAL_PHONE, WORK_POSITION | |
| filter | No | Filter object (e.g. { '>OPPORTUNITY': 10000, 'STAGE_ID': 'WON' }) | |
| select | No | Array of field names to return (projection) | |
| confirm | No | Set to true to confirm destructive actions when BX24_CONFIRM_DESTRUCTIVE is enabled. | |
| userfield | No | User field definition: FIELD_NAME, USER_TYPE_ID, LABEL | |
| userfieldId | No | CRM userfield ID (e.g. UF_CRM_123) | |
| departmentId | No | Department ID |