Actions31
- Company Actions
- Contact Actions
- Deal Actions
- Item Actions
- Lead Actions
- User Custom Method Actions
Overview
This node integrates with the Bitrix24 REST API to list company records from a Bitrix24 CRM system. It allows users to retrieve multiple companies based on specified filters, sorting orders, and selected fields. This is useful for workflows that need to fetch company data for reporting, synchronization with other systems, or conditional processing.
Typical use cases include:
- Extracting a filtered list of companies matching certain criteria (e.g., name contains "Tech").
- Retrieving specific fields such as company ID, title, or industry.
- Sorting companies by a field in ascending or descending order.
- Paginating through company records starting at a given offset.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method used to authenticate with Bitrix24 API. Options: OAuth2 or Webhook. |
| Input Type | How input parameters are provided: - Using Fields: Fill individual fields for parameters. - Using JSON: Provide raw JSON data directly. |
| JSON Body | Raw JSON data representing the request body when using the "Using JSON" input type. |
| Parameters | Collection of parameters to customize the list operation when using "Using Fields": - Select Names or IDs: Choose which fields to include in the response. - Filter Conditions: Add one or more filters to restrict results. - Order: Define sorting order by specifying field(s) and direction (ASC/DESC). - Start: Number indicating the offset to start listing from (for pagination). |
Details of Parameters collection:
- Select Names or IDs: Multi-select list of fields to return for each company. Can be chosen from predefined options or specified via expressions.
- Filter Conditions: Multiple filter rules can be added. Each filter includes:
- Field: The company field to filter on.
- Operation: Comparison operator (e.g., equals, contains, greater than).
- Value: The value to compare against.
- Order: One or more sorting rules, each specifying:
- Field: The field to sort by.
- Direction: Sort direction, either ASC (ascending) or DESC (descending).
- Start: Numeric offset to begin listing companies from (default 0).
Output
The node outputs an array of company objects in the json output field. Each object contains the fields requested via the "Select Names or IDs" parameter or all fields if none specified. The structure corresponds to the Bitrix24 company entity schema.
No binary data output is produced by this node.
Dependencies
- Requires access to a Bitrix24 account with appropriate permissions to read company data.
- Requires configuration of authentication credentials in n8n:
- Either an OAuth2 credential for Bitrix24.
- Or a Webhook-based API key credential.
- Network connectivity to Bitrix24 REST API endpoints.
Troubleshooting
- Authentication errors: Ensure the configured API credentials are valid and have sufficient permissions.
- Empty results: Check filter conditions and ensure they match existing company data. Also verify the "Start" offset is within range.
- Invalid field names: When selecting fields or filtering, use valid Bitrix24 company field names. Use the node's load options to pick correct fields.
- API rate limits: Bitrix24 may limit API calls; consider adding delays or handling retries if you encounter rate limit errors.
- Malformed JSON: If using the JSON input type, ensure the JSON body is correctly formatted.
Links and References
- Bitrix24 REST API Documentation
- n8n Expressions Documentation
- Bitrix24 Company Entity Fields (for reference on available fields)