Actions89
- Direct API Actions
- CRM Actions
- Task Actions
- User Actions
- SPA Actions
- Activity Actions
- Automation Actions
- Document Generator Actions
- Data Storage Actions
- Chat Actions
Overview
This node integrates with the Bitrix24 platform, specifically to retrieve user data when using the "User" resource and the "Get All Users" operation. It allows users to fetch a list of users from their Bitrix24 account, supporting options such as filtering, sorting, limiting the number of results, and choosing between returning all users or a limited subset.
Common scenarios where this node is beneficial include:
- Synchronizing user lists from Bitrix24 into other systems.
- Automating workflows that require up-to-date user information.
- Reporting or auditing user accounts within Bitrix24.
Practical example: A company wants to export all active users from Bitrix24 to an HR system daily. This node can be configured to fetch all users, optionally filtered by criteria like department or role, and then pass the data downstream for further processing.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method used to authenticate with Bitrix24. Options: OAuth2 (recommended for production), Webhook (simpler but less secure), API Key. |
| Return All | Boolean flag indicating whether to return all user records or limit the output. If false, the number of returned users is capped by the "Limit" property. |
| Limit | Maximum number of user records to return when "Return All" is false. Accepts values from 1 to 500. |
| Filter | JSON object specifying filter criteria to narrow down which users are retrieved. |
| Order | JSON object specifying sort criteria to order the returned users. |
| Admin Mode | Boolean flag indicating whether to use admin mode for the request, potentially affecting permissions and data visibility. |
| Custom Parameters | JSON object allowing additional custom parameters to be sent with the API request. |
| Access Token | String containing an access token for authentication purposes, if applicable. |
Output
The node outputs an array of JSON objects representing users retrieved from Bitrix24. Each item in the output corresponds to a user record with fields as provided by the Bitrix24 API. The exact structure depends on the API response but typically includes user identifiers, names, contact details, roles, and other metadata.
If an error occurs and the node is configured to continue on failure, the output will contain an object with an error field describing the issue, along with the resource name and a timestamp.
The node does not output binary data.
Dependencies
- Requires connection to Bitrix24 via one of the supported authentication methods: OAuth2, webhook URL, or API key.
- Needs appropriate credentials configured in n8n for the chosen authentication method.
- Relies on Bitrix24 API endpoints to fetch user data.
- No additional external libraries beyond those bundled with the node.
Troubleshooting
- Authentication errors: Ensure that the selected authentication method is correctly configured with valid credentials or tokens. OAuth2 requires proper token setup; webhooks must be valid URLs; API keys must have sufficient permissions.
- API rate limits or timeouts: When fetching large numbers of users, consider enabling "Return All" carefully or setting reasonable limits to avoid hitting API rate limits.
- Invalid filter or order JSON: Filters and ordering must be valid JSON objects matching Bitrix24 API expectations. Malformed JSON or unsupported fields may cause errors.
- Permission issues: Using "Admin Mode" may be necessary to access certain user data. Lack of permissions can result in incomplete or empty results.
- Error messages: If the node throws errors related to API calls, check network connectivity, credential validity, and Bitrix24 service status.