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 Contact records. It allows users to retrieve multiple contacts from their Bitrix24 CRM system based on specified filters, selected fields, sorting order, and pagination start index.
Common scenarios where this node is beneficial include:
- Synchronizing contact data from Bitrix24 into other systems or databases.
- Generating reports or dashboards that require filtered lists of contacts.
- Automating workflows that depend on retrieving specific subsets of contacts.
For example, a user might configure this node to fetch all contacts whose names contain "Smith", selecting only the email and phone number fields, sorted by creation date descending, starting from the 10th record.
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 | (Shown if Input Type is JSON) Raw JSON data representing the request body for listing contacts. |
| Parameters | Collection of parameters to customize the list operation when using fields input type: - Select Names or IDs: Choose which contact fields to include in the response. - Filter Conditions: Define one or more filters to narrow down results, specifying field, operation (e.g., equals, contains), and value. - Order: Specify sorting order by field and direction (ASC or DESC). Multiple ordering criteria can be added. - Start: Number indicating the offset from which to start returning records (pagination). |
Output
The node outputs an array of contact objects in the json output field. Each object represents a contact record with the fields requested via the "Select Names or IDs" parameter or included by default if none specified.
No binary data output is produced by this node.
Dependencies
- Requires valid authentication credentials for Bitrix24, either via OAuth2 or Webhook method.
- The node depends on Bitrix24 REST API availability and correct permissions to access contact data.
- No additional external services or environment variables are required beyond the configured authentication.
Troubleshooting
- Authentication errors: Ensure the provided API key or OAuth2 token is valid and has sufficient permissions to read contacts.
- Empty results: Check filter conditions and ensure they match existing contacts; also verify the "Start" parameter is within range.
- Invalid field names: When selecting fields or filtering, use valid Bitrix24 contact field names or IDs; invalid names may cause errors or empty responses.
- JSON syntax errors: If using JSON input type, ensure the JSON body is well-formed and matches the expected structure for the Bitrix24 API.
- API rate limits: Bitrix24 may impose rate limits; if requests fail repeatedly, consider adding delays or reducing request frequency.
Links and References
- Bitrix24 REST API Documentation
- n8n Expressions Documentation (for dynamic field/ID expressions)