Bitrix24 icon

Bitrix24

Interact with Bitrix24 CRM and business platform
Join our community

Actions290

Overview

This node integrates with the Bitrix24 CRM and business platform, specifically enabling users to retrieve multiple records from various CRM entities. The "Get All" operation under the "CRM" resource fetches all or a limited set of items (such as contacts, deals, leads, companies, quotes, invoices, products, or activities) based on user-defined filters, sorting, and selection criteria.

Common scenarios include:

  • Exporting all contacts or deals for reporting or backup.
  • Synchronizing CRM data with other systems by fetching all relevant records.
  • Filtering and sorting CRM entities to analyze specific subsets, e.g., all deals created after a certain date.

Practical example:

  • A sales manager wants to pull all deals sorted by creation date descending, filtering only those with a title containing "Q2 Campaign", to analyze pipeline progress.

Properties

Name Meaning
Authentication Method to authenticate with Bitrix24:
- OAuth2 (recommended for production)
- Webhook (simpler but less secure)
- API Key authentication
Entity The CRM entity type to work with. Options include:
- Contact
- Deal
- Lead
- Company
- Quote
- Invoice
- Product
- Activity
Return All Boolean flag indicating whether to return all results or limit the output. If false, limits results according to Max pages to load.
Max pages to load Maximum number of pages to load when Return All is false. Each page contains up to 50 items. This controls pagination depth to avoid excessive data retrieval.
Options Additional options to customize the query:
- Select: Fields to return, specified as JSON array or comma-separated string (e.g., ["ID","TITLE","NAME"] or ID,TITLE,NAME)
- Filter: Filter criteria in JSON format (e.g., {"TITLE": "Test", ">DATE_CREATE": "2023-01-01"})
- Order: Sort order in JSON format (e.g., {"DATE_CREATE": "DESC", "ID": "ASC"})

Output

The node outputs an array of JSON objects representing the retrieved CRM records matching the query parameters. Each object corresponds to one record of the selected entity type and includes fields as specified by the "Select" option or defaults to standard fields if not specified.

If binary data were involved (not applicable here), it would be summarized accordingly, but this node focuses on JSON data output.

Example output snippet (conceptual):

[
  {
    "ID": "123",
    "TITLE": "Sample Deal",
    "DATE_CREATE": "2023-04-01T12:00:00Z",
    "ASSIGNED_BY_ID": "45"
  },
  {
    "ID": "124",
    "TITLE": "Another Deal",
    "DATE_CREATE": "2023-04-02T08:30:00Z",
    "ASSIGNED_BY_ID": "46"
  }
]

Dependencies

  • Requires connection to Bitrix24 CRM via one of the supported authentication methods (OAuth2, webhook URL, or API key).
  • Proper credentials must be configured in n8n for the chosen authentication method.
  • Network access to Bitrix24 API endpoints.
  • No additional external libraries beyond those bundled with the node.

Troubleshooting

  • Common issues:

    • Authentication failures due to incorrect or expired credentials.
    • API rate limits or pagination limits causing incomplete data retrieval.
    • Malformed filter, select, or order JSON strings leading to API errors.
    • Selecting unsupported fields or entity types.

  • Error messages:

    • Errors returned from Bitrix24 API will be surfaced with their message in the output JSON under an error field if "Continue On Fail" is enabled.
    • Typical error: "Failed to load CRM fields" or "Failed to load deal categories" indicate issues fetching metadata, often due to permission or connectivity problems.
    • "Invalid filter format" or similar indicates JSON syntax errors in filter/order/select inputs.

  • Resolutions:

    • Verify and refresh credentials.
    • Validate JSON syntax in filter, select, and order properties.
    • Limit the number of pages loaded if hitting API limits.
    • Check Bitrix24 user permissions for accessing requested entities.

Links and References

Discussion