Bitrix24 icon

Bitrix24

Interact with Bitrix24 CRM and business platform

Actions290

Overview

This node integrates with the Bitrix24 platform, specifically allowing users to retrieve all user records from Bitrix24's user management system. It is useful in scenarios where you need to synchronize user data, audit user accounts, or automate workflows based on user information stored in Bitrix24.

For example, you might use this node to:

  • Fetch a complete list of users for reporting or analytics.
  • Retrieve filtered subsets of users based on specific criteria.
  • Automate onboarding processes by pulling user details into other systems.

The "Get All Users" operation supports returning either all users or a limited subset, with options to filter and sort the results.

Properties

Name Meaning
Authentication Method used to authenticate with Bitrix24. Options: OAuth2 (recommended), Webhook (simpler), API Key
Return All Boolean flag indicating whether to return all user records or limit the number of returned results
Options Collection of additional parameters:
- Filter JSON object specifying filter criteria to narrow down which users are returned
- Order JSON object specifying sorting order of the returned users
- Admin Mode Boolean flag to enable admin mode for the request
- Custom Parameters JSON object for any extra parameters to include in the API call

Output

The node outputs an array of user objects in the json field. Each object represents a user record retrieved from Bitrix24, containing fields such as user ID, name, email, and other user attributes as provided by the Bitrix24 API.

If the node encounters an error and "Continue On Fail" is enabled, it outputs an object with an error message, the resource name ("user"), and a timestamp.

No binary data output is produced by this node.

Dependencies

  • Requires valid authentication credentials for Bitrix24 via one of the supported methods: OAuth2, webhook URL, or API key.
  • The node depends on Bitrix24's REST API endpoints to fetch user data.
  • Proper configuration of authentication credentials within n8n is necessary.
  • Network access to Bitrix24 API endpoints must be available.

Troubleshooting

  • Common Issues:

    • Authentication failures due to invalid or expired credentials.
    • API rate limits or permission restrictions preventing data retrieval.
    • Malformed JSON in filter, order, or custom parameters causing API errors.
  • Error Messages:

    • Errors thrown by the Bitrix24 API will be surfaced in the node's output if "Continue On Fail" is enabled.
    • Typical messages may include authentication errors, permission denied, or invalid parameter format.
  • Resolutions:

    • Verify that the selected authentication method is correctly configured and active.
    • Ensure JSON inputs for filters and ordering are well-formed.
    • Check Bitrix24 user permissions and API quotas.
    • Enable "Continue On Fail" to capture error details for debugging.

Links and References

Discussion