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
The Bitrix24 node allows interaction with the Bitrix24 CRM and business platform. Specifically, the Data Storage - Get operation enables users to retrieve data records from Bitrix24 entities or resources. This is useful for scenarios such as fetching CRM contacts, deals, leads, companies, or other custom entities stored in Bitrix24.
Typical use cases include:
- Retrieving filtered lists of CRM records based on specific criteria.
- Selecting particular fields from records to minimize data transfer.
- Ordering results and paginating through large datasets.
For example, a user might fetch all deals created after a certain date, selecting only the deal name and amount fields, ordered by creation date.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method to authenticate API requests: - OAuth2 (recommended for production) - Webhook (simpler but less secure) - API Key |
| Options | Collection of optional parameters to customize the data retrieval: • Access Token: token string for authentication • Filter: JSON object specifying filter criteria to narrow down results • Select: comma-separated list of fields to return • Order: JSON object defining sorting order of results • Start: number indicating the start position for pagination |
Output
The node outputs an array of items where each item contains a json property representing a single record retrieved from Bitrix24 according to the specified filters and options.
- The
jsonoutput field includes the fields requested via the "Select" option or all fields if none specified. - If an error occurs and "Continue On Fail" is enabled, the output will contain an error object with keys:
error(message),resource(the resource name), andtimestamp. - The node does not output binary data.
Dependencies
- Requires valid authentication credentials depending on the chosen method (OAuth2, webhook URL, or API key).
- Needs proper configuration of these credentials within n8n.
- Relies on Bitrix24 API endpoints to fetch data; thus, network connectivity and API access permissions are necessary.
Troubleshooting
Common issues:
- Invalid or expired authentication tokens leading to authorization errors.
- Incorrect filter or order JSON syntax causing API request failures.
- Requesting fields that do not exist in the selected resource may result in empty or partial data.
- Pagination parameters misconfigured, resulting in missing data pages.
Error messages:
- Errors returned from Bitrix24 API will be surfaced as exceptions unless "Continue On Fail" is enabled.
- Typical error messages include authentication failures, invalid parameters, or rate limiting notices.
Resolutions:
- Verify and refresh authentication credentials.
- Validate JSON syntax for filter and order inputs.
- Confirm field names against Bitrix24 entity schema.
- Adjust pagination parameters appropriately.