Users: Overview of Methods

The user profile is a key object in Bitrix24. Without a user profile, an employee cannot utilize the corporate account and CRM. The user ID can be used to:

• configure access permissions,
• assign tasks among employees,
• retrieve information about employee actions.

Quick navigation: all methods

User documentation: How to invite employees to Bitrix24

How to Work with UsersHow to Work with Users

Use the method:

• user.add to invite new users. The username must not exceed 25 characters.
• user.update to edit existing user profiles, terminate or reinstate an employee.

Connection with Other ObjectsConnection with Other Objects

CRM. The user ID is used in system fields:

• editable: responsible person, observers,
• read-only: who created, who modified, who moved to the stage.

Use the methods crm.item.* to read or modify fields.

Calendar. To work with an employee's calendar, specify the user ID in the ownerID field in the methods calendar.section.*. To create or modify a meeting with multiple participants, specify the user IDs in the host and attendees fields in the methods calendar.event.*.

News Feed. Use user IDs in the methods:

• log.blogpost.* to address a post to specific employees,
• log.blogpost.getusers.important to check who among the employees has read an important post.

Online Store. The user ID is used in system fields:

• editable: responsible for the order, shipment, payment,
• read-only: who changed the status, who marked, who canceled, who processed a return.

Use the methods sale.order.*, sale.payment.*, sale.shipment.* to read or modify fields.

Chats. Use user IDs in the methods im.chat.*, im.chat.user.*, im.user.* to assign a chat owner, edit the list of participants, or retrieve information about chat participants.

Open Channels. Use user IDs:

• to configure the queue of responsible employees in the methods imopenlines.config.*,
• to assign dialogues to employees in the methods imopenlines.bot.session.*, imopenlines.crm.chat.user.*, imopenlines.operator.*.

Telephony. Use the user ID:

• to route a phone call to them in the methods telephony.externalcall.*,
• to obtain call statistics for the employee using the method voximplant.statistic.get,
• to configure a SIP device in the methods voximplant.user.*.

Time Tracking. Use user IDs:

• to manage the user's workday in the methods timeman.*,
• to configure the tool for time control in the methods timeman.timecontrol.*,
• to retrieve information about the work schedule using the method timeman.schedule.get.

Tasks. The user ID is used in system fields:

• editable: Creator, executor, Participants, observers,
• read-only: who modified the task, who changed the status, who completed the task.

Use the methods tasks.task.* to read or modify fields. To find out or edit the time spent on a task for a user — task.elapseditem.*.

Workgroups and Projects. Use user IDs in the methods sonet_group.user.* to change the composition of group members and their roles. Specify the user ID in the SCRUM_MASTER_ID field to create a Scrum group.

Company Structure. Use user IDs to manage the assignment of employees to company departments in the methods department.*.

User Binding TypeUser Binding Type

In Bitrix24, you can create custom fields with the type "user binding." Fields accept a user ID if they are simple, and an array of IDs if they are multiple.

• Custom fields are available in the sections CRM and online store.
• Custom properties are available in the sections universal lists, data storage, and in the product catalog.
• Parameters and variables are available in workflows.

User Access RightsUser Access Rights

Use the user ID to configure access rights in the methods:

• Drive file methods disk.folder.uploadfile and disk.storage.uploadfile,
• Document generator documentgenerator.role.fillaccesses,
• Sites landing.site.setRights.

Working with Extranet UsersWorking with Extranet Users

Extranet users are those who have limited access to Bitrix24 functionality. CRM is not available for extranet users, but chats, groups, and the calendar are accessible.

To invite an extranet user, use the method user.add with the parameters:

• EXTRANET: Y — marking as an external user,
• SONET_GROUP_ID: [...] — IDs of the groups the user will belong to.

When adding an extranet user to a group using the method sonet_group.user.add, the group automatically changes its type to external.

WidgetsWidgets

An application can be embedded in the user profile. This allows the application to be used without leaving the user detail form.

• Context menu item in the profile USER_PROFILE_MENU

• Context menu item for the top profile button USER_PROFILE_TOOLBAR

User Data Access LevelsUser Data Access Levels

To ensure the security of employee data, different versions of the User scope are available for applications and webhooks.

• user_brief provides access to user information without contact details. This is sufficient for scenarios where displaying the user's full name in a third-party application interface is required.

• user_basic opens basic information and contact details of users. This is required for scenarios related to making calls or sending e-mail messages.

• user provides full access to user information, the ability to invite new users, and modify existing data.

Overview of MethodsOverview of Methods

Scope: user

Who can execute the method: depending on the method

Method	Description
user.add	Invites a user
user.update	Updates user data
user.current	Retrieves information about the current user
user.get	Retrieves a filtered list of users
user.search	Retrieves a list of users with accelerated search by personal data
user.fields	Retrieves a list of user profile fields