Actions25
Overview
This node integrates with the Bitrix24 CRM system to manage Contact records. Specifically, the Contact - Get operation allows users to retrieve a single contact record either by its unique ID or by applying custom filter criteria on contact fields.
Common scenarios where this node is useful include:
- Fetching detailed information about a specific contact when you know their ID.
- Searching for a contact based on one or more field values (e.g., email, phone number, name).
- Selecting only certain fields of the contact record to optimize data usage.
Practical example:
- You have a workflow that receives an email address and you want to find the corresponding contact in Bitrix24. Using the "Get By Filter" option, you can specify the email field equals the given address and retrieve the matching contact's details.
Properties
| Name | Meaning |
|---|---|
| Get By | Choose how to get the contact: • ID: Retrieve by the contact's unique ID. • Filter: Retrieve by specifying one or more filter conditions on contact fields. |
| ID | The unique identifier of the contact record to retrieve. Required if "Get By" is set to "ID". |
| Filter Fields | One or more filter conditions to apply when retrieving the contact by filter. Each filter consists of: • Field Name: The contact field to filter by. • Operation: Comparison operator (equals, not equals, contains, etc.). • Value: The value to compare against. |
| Select Fields | List of contact fields to retrieve. If empty, a default set of fields will be returned. |
Output
The node outputs an array of JSON objects representing the retrieved contact(s). For the Get operation, it returns either:
- A single contact object matching the ID or filter criteria, containing the requested fields.
- An error object
{ error: "Запись не найдена" }("Record not found") if no matching contact is found.
The output JSON structure corresponds to the Bitrix24 contact record schema, including standard and custom fields as requested.
No binary data output is produced by this operation.
Dependencies
- Requires a valid Bitrix24 API webhook URL configured in the node credentials.
- The node uses HTTP POST requests to Bitrix24 REST API endpoints.
- No additional external services are required beyond Bitrix24 itself.
Troubleshooting
- Missing Credentials or Webhook URL: The node throws errors if the Bitrix24 API credentials or webhook URL are not provided. Ensure these are correctly configured.
- Invalid ID or No Matching Record: If the specified contact ID does not exist, or the filter matches no records, the node returns an error message indicating the record was not found.
- Filter Syntax Errors: Incorrectly formatted filter fields or unsupported operations may cause the request to fail. Verify filter field names and operations are valid.
- API Response Issues: Network problems or Bitrix24 API downtime can cause failures. Check connectivity and Bitrix24 service status.
- Language Setting: The node sets a default language environment variable; if localization issues arise, verify the language configuration in credentials.
Links and References
- Bitrix24 REST API Documentation
- Bitrix24 CRM Contacts API
- n8n documentation on Creating Custom Nodes