Bitrix24
Extract your Bitrix24 CRM data and load it directly into your data warehouse with Renta. Centralize deals, leads, contacts, companies, and user-defined fields for advanced analytics, sales funnel reporting, and conversion tracking — all without writing a single line of code.
Authentication
Renta connects to Bitrix24 using an incoming webhook — a permanent, scoped API token generated directly in your Bitrix24 portal. No OAuth flow or third-party app installation is required.
The webhook URL acts as a combined endpoint and secret. It encodes your portal address, user ID, and access token in a single string. Treat it like a password and do not share it publicly.
Connect Bitrix24 source
Setting up the Bitrix24 integration takes about five minutes. You will create an incoming webhook in your Bitrix24 portal and paste the URL into Renta.
In your Bitrix24 portal, navigate to Developer resources > Other > Incoming webhook.
- Webhook URL.
Copy the generated URL — you will need it later. - Permissions configuration.
Enable at minimum the CRM (crm) and Users (user) scopes. If you plan to sync tasks, telephony records, calendar events, or disk files in the future, enable relevant scopes now (e.g., Tasks, Telephony, Calendar). Permissions can be updated at any time without changing the webhook URL. - Save.
Click the Save button.

In Renta, open Connections > Catalog. Find Bitrix24 in the CRM category and click its card to open the connection form.

Fill in the connection form:
- Source name.
Enter a descriptive name for this connection. This name is only used in the Renta interface. - Webhook URL.
Paste the full webhook URL copied from Bitrix24. - Save.
Click Save. Renta will validate the webhook to ensure the portal is reachable and scopes are correct.

Pipeline configuration
When creating a pipeline with the Bitrix24 source, configure the following settings.

Report types
Select the CRM object you want to export. Each report type maps to one destination table and one Bitrix24 REST API endpoint.
| Report type | Bitrix24 API method | Description |
|---|---|---|
| Deals | crm.deal.list | Sales deals with stage, pipeline, opportunity amount, and responsible manager. |
| Leads | crm.lead.list | Inbound leads with source, status, phone, email, and user-defined fields. |
| Contacts | crm.contact.list | Individual contacts linked to companies, deals, and leads. |
| Companies | crm.company.list | Company profiles with industry, revenue, and contact details. |
| Activities | crm.activity.list | CRM activities including calls, emails, and meetings linked to deals or leads. |
| Users | user.get | Bitrix24 portal users — used for joining with assigned_by_id and responsible_id fields. |
| Deal categories | crm.dealcategory.list | Sales pipeline definitions (funnel names and sort order). |
| Deal stages | crm.status.list | Stage definitions for all pipelines, including stage names, colors, and semantic labels (won/lost/in progress). |
| Currencies | crm.currency.list | Currency reference table with codes, symbols, and exchange rates. Base currency is set at the portal level. |
| Userfields | crm.*.userfield.list | Metadata for all user-defined fields (UF_CRM_*) across deals, leads, contacts, and companies — field names, types, and enumeration values. |
Parameters
Select the specific fields to include in your destination table. Your dataset schema is defined entirely by the parameters you choose here. Unselected fields will not appear in the output.
| Name | API name | Description |
|---|---|---|
Id · Required text | id | Unique identifier. |
Title text | title | Title/name of the record. |
Type Id text | type_id | Type code. |
Stage Id text | stage_id | Current stage code in the pipeline. |
Previous Stage Id text | previous_stage_id | Previous stage code before the last transition. |
Probability text | probability | Deal probability of success (percent). |
Currency Id text | currency_id | ISO currency code (RUB, KZT, USD, ...). |
Opportunity text | opportunity | Monetary amount (stored as string). |
Is Manual Opportunity text | is_manual_opportunity | "Y"/"N" — whether OPPORTUNITY was set manually. |
Tax Value text | tax_value | Tax value for the monetary amount. |
Lead Id text | lead_id | Related lead ID. |
Company Id text | company_id | Related company ID. |
Contact Id text | contact_id | Related contact ID. |
Quote Id text | quote_id | Related quote ID. |
Begindate datetime | begindate | Planned start date. |
Closedate datetime | closedate | Planned close date. |
Assigned By Id text | assigned_by_id | ID of the user responsible for the record. |
Created By Id text | created_by_id | ID of the user who created the record. |
Modify By Id text | modify_by_id | ID of the user who last modified the record. |
Date Create datetime | date_create | Creation timestamp. |
Date Modify · Required datetime | date_modify | Last modification timestamp. |
Opened text | opened | "Y"/"N" — whether the record is public. |
Closed text | closed | "Y"/"N" — whether the record is closed. |
Comments text | comments | Free-form comments. |
Additional Info text | additional_info | Additional Info field from Bitrix24 API. |
Location Id text | location_id | Location Id field from Bitrix24 API. |
Category Id text | category_id | Pipeline (deal category) ID. |
Stage Semantic Id text | stage_semantic_id | Stage semantic: P=in-progress, S=success, F=failed. |
Is New text | is_new | "Y"/"N" — new record flag. |
Is Recurring text | is_recurring | "Y"/"N" — whether the record is recurring. |
Is Return Customer text | is_return_customer | "Y"/"N" — repeat customer flag. |
Is Repeated Approach text | is_repeated_approach | "Y"/"N" — repeated approach flag. |
Source Id text | source_id | Lead/traffic source code. |
Source Description text | source_description | Free-form description of the lead source. |
Originator Id text | originator_id | External system identifier that created the record. |
Origin Id text | origin_id | External record identifier in the originating system. |
Moved By Id text | moved_by_id | ID of the user who moved the record to the current stage. |
Moved Time datetime | moved_time | Timestamp when the record was moved to the current stage. |
Last Activity Time datetime | last_activity_time | Timestamp of the last activity on the record. |
Utm Source text | utm_source | UTM source marker. |
Utm Medium text | utm_medium | UTM medium marker. |
Utm Campaign text | utm_campaign | UTM campaign marker. |
Utm Content text | utm_content | UTM content marker. |
Utm Term text | utm_term | UTM term marker. |
Last Communication Time datetime | last_communication_time | Timestamp of the last communication. |
Last Activity By text | last_activity_by | ID of the user who performed the last activity. |
Custom fields values structure | custom_fields_values | User-defined fields (UF_CRM_*) from Bitrix24 admin panel. Each element carries the Bitrix24 field key and its serialized value. Metadata fields field_id / field_name / field_type are populated from crm.{entity}.userfield.list at pipeline start. is_computed stays NULL (Bitrix24 has no equivalent). |
Partition Date · Required date | partition_date | Creation day derived from DATE_CREATE, truncated to a date. Partition key of the destination table: day granularity keeps the incremental MERGE cheap and its partition list small. |
| Name | API name | Description |
|---|---|---|
Id · Required text | id | Unique identifier. |
Title text | title | Title/name of the record. |
Honorific text | honorific | Honorific (Mr./Mrs./...). |
Name text | name | First name. |
Second Name text | second_name | Middle name. |
Last Name text | last_name | Last name. |
Company Title text | company_title | Name of the related company. |
Company Id text | company_id | Related company ID. |
Contact Id text | contact_id | Related contact ID. |
Is Return Customer text | is_return_customer | "Y"/"N" — repeat customer flag. |
Birthdate datetime | birthdate | Birth date. |
Source Id text | source_id | Lead/traffic source code. |
Source Description text | source_description | Free-form description of the lead source. |
Status Id text | status_id | Current status code. |
Status Description text | status_description | Free-form status description. |
Post text | post | Job title/position. |
Comments text | comments | Free-form comments. |
Currency Id text | currency_id | ISO currency code (RUB, KZT, USD, ...). |
Opportunity text | opportunity | Monetary amount (stored as string). |
Is Manual Opportunity text | is_manual_opportunity | "Y"/"N" — whether OPPORTUNITY was set manually. |
Has Phone text | has_phone | "Y"/"N" — phone is present. |
Has Email text | has_email | "Y"/"N" — email is present. |
Has Imol text | has_imol | "Y"/"N" — Open Line channel is present. |
Assigned By Id text | assigned_by_id | ID of the user responsible for the record. |
Created By Id text | created_by_id | ID of the user who created the record. |
Modify By Id text | modify_by_id | ID of the user who last modified the record. |
Date Create datetime | date_create | Creation timestamp. |
Date Modify · Required datetime | date_modify | Last modification timestamp. |
Date Closed datetime | date_closed | Date the record was closed. |
Status Semantic Id text | status_semantic_id | Status semantic: P=in-progress, S=success, F=failed. |
Opened text | opened | "Y"/"N" — whether the record is public. |
Originator Id text | originator_id | External system identifier that created the record. |
Origin Id text | origin_id | External record identifier in the originating system. |
Moved By Id text | moved_by_id | ID of the user who moved the record to the current stage. |
Moved Time datetime | moved_time | Timestamp when the record was moved to the current stage. |
Address text | address | Physical address, line 1. |
Address 2 text | address_2 | Physical address, line 2. |
Address City text | address_city | City. |
Address Postal Code text | address_postal_code | Postal code. |
Address Region text | address_region | Region / state. |
Address Province text | address_province | Province. |
Address Country text | address_country | Country name. |
Address Country Code text | address_country_code | ISO country code. |
Address Loc Addr Id text | address_loc_addr_id | Internal Bitrix24 location-address ID. |
Utm Source text | utm_source | UTM source marker. |
Utm Medium text | utm_medium | UTM medium marker. |
Utm Campaign text | utm_campaign | UTM campaign marker. |
Utm Content text | utm_content | UTM content marker. |
Utm Term text | utm_term | UTM term marker. |
Last Communication Time datetime | last_communication_time | Timestamp of the last communication. |
Last Activity By text | last_activity_by | ID of the user who performed the last activity. |
Last Activity Time datetime | last_activity_time | Timestamp of the last activity on the record. |
Phone structure | phone | Multi-valued phone list. Each element carries VALUE_TYPE (WORK/MOBILE/HOME/...), VALUE (number), and TYPE_ID=PHONE. |
Email structure | email | Multi-valued email list. Each element: VALUE_TYPE, VALUE (address), TYPE_ID=EMAIL. |
Web structure | web | Multi-valued website list. Each element: VALUE_TYPE, VALUE (URL), TYPE_ID=WEB. |
Im structure | im | Multi-valued IM / messenger list. Each element: VALUE_TYPE (SKYPE/TELEGRAM/WHATSAPP/...), VALUE (handle), TYPE_ID=IM. |
Custom fields values structure | custom_fields_values | User-defined fields (UF_CRM_*) from Bitrix24 admin panel. Each element carries the Bitrix24 field key and its serialized value. Metadata fields field_id / field_name / field_type are populated from crm.{entity}.userfield.list at pipeline start. is_computed stays NULL (Bitrix24 has no equivalent). |
Partition Date · Required date | partition_date | Creation day derived from DATE_CREATE, truncated to a date. Partition key of the destination table: day granularity keeps the incremental MERGE cheap and its partition list small. |
| Name | API name | Description |
|---|---|---|
Id · Required text | id | Unique identifier. |
Post text | post | Job title/position. |
Comments text | comments | Free-form comments. |
Honorific text | honorific | Honorific (Mr./Mrs./...). |
Name text | name | First name. |
Second Name text | second_name | Middle name. |
Last Name text | last_name | Last name. |
Photo text | photo | Photo file reference. |
Lead Id text | lead_id | Related lead ID. |
Type Id text | type_id | Type code. |
Source Id text | source_id | Lead/traffic source code. |
Source Description text | source_description | Free-form description of the lead source. |
Company Id text | company_id | Related company ID. |
Birthdate datetime | birthdate | Birth date. |
Export text | export | "Y"/"N" — include in export flag. |
Has Phone text | has_phone | "Y"/"N" — phone is present. |
Has Email text | has_email | "Y"/"N" — email is present. |
Has Imol text | has_imol | "Y"/"N" — Open Line channel is present. |
Date Create datetime | date_create | Creation timestamp. |
Date Modify · Required datetime | date_modify | Last modification timestamp. |
Assigned By Id text | assigned_by_id | ID of the user responsible for the record. |
Created By Id text | created_by_id | ID of the user who created the record. |
Modify By Id text | modify_by_id | ID of the user who last modified the record. |
Opened text | opened | "Y"/"N" — whether the record is public. |
Originator Id text | originator_id | External system identifier that created the record. |
Origin Id text | origin_id | External record identifier in the originating system. |
Origin Version text | origin_version | Version of the originating external record. |
Address text | address | Physical address, line 1. |
Address 2 text | address_2 | Physical address, line 2. |
Address City text | address_city | City. |
Address Postal Code text | address_postal_code | Postal code. |
Address Region text | address_region | Region / state. |
Address Province text | address_province | Province. |
Address Country text | address_country | Country name. |
Address Loc Addr Id text | address_loc_addr_id | Internal Bitrix24 location-address ID. |
Utm Source text | utm_source | UTM source marker. |
Utm Medium text | utm_medium | UTM medium marker. |
Utm Campaign text | utm_campaign | UTM campaign marker. |
Utm Content text | utm_content | UTM content marker. |
Utm Term text | utm_term | UTM term marker. |
Last Communication Time datetime | last_communication_time | Timestamp of the last communication. |
Last Activity By text | last_activity_by | ID of the user who performed the last activity. |
Last Activity Time datetime | last_activity_time | Timestamp of the last activity on the record. |
Phone structure | phone | Multi-valued phone list. Each element carries VALUE_TYPE (WORK/MOBILE/HOME/...), VALUE (number), and TYPE_ID=PHONE. |
Email structure | email | Multi-valued email list. Each element: VALUE_TYPE, VALUE (address), TYPE_ID=EMAIL. |
Web structure | web | Multi-valued website list. Each element: VALUE_TYPE, VALUE (URL), TYPE_ID=WEB. |
Im structure | im | Multi-valued IM / messenger list. Each element: VALUE_TYPE (SKYPE/TELEGRAM/WHATSAPP/...), VALUE (handle), TYPE_ID=IM. |
Custom fields values structure | custom_fields_values | User-defined fields (UF_CRM_*) from Bitrix24 admin panel. Each element carries the Bitrix24 field key and its serialized value. Metadata fields field_id / field_name / field_type are populated from crm.{entity}.userfield.list at pipeline start. is_computed stays NULL (Bitrix24 has no equivalent). |
Partition Date · Required date | partition_date | Creation day derived from DATE_CREATE, truncated to a date. Partition key of the destination table: day granularity keeps the incremental MERGE cheap and its partition list small. |
| Name | API name | Description |
|---|---|---|
Id · Required text | id | Unique identifier. |
Company Type text | company_type | Company type: CUSTOMER, SUPPLIER, ... |
Title text | title | Title/name of the record. |
Logo text | logo | Logo file reference. |
Lead Id text | lead_id | Related lead ID. |
Has Phone text | has_phone | "Y"/"N" — phone is present. |
Has Email text | has_email | "Y"/"N" — email is present. |
Has Imol text | has_imol | "Y"/"N" — Open Line channel is present. |
Assigned By Id text | assigned_by_id | ID of the user responsible for the record. |
Created By Id text | created_by_id | ID of the user who created the record. |
Modify By Id text | modify_by_id | ID of the user who last modified the record. |
Banking Details text | banking_details | Banking details. |
Industry text | industry | Industry code. |
Revenue text | revenue | Annual revenue (string). |
Currency Id text | currency_id | ISO currency code (RUB, KZT, USD, ...). |
Employees text | employees | Employee count range code. |
Comments text | comments | Free-form comments. |
Date Create datetime | date_create | Creation timestamp. |
Date Modify · Required datetime | date_modify | Last modification timestamp. |
Opened text | opened | "Y"/"N" — whether the record is public. |
Is My Company text | is_my_company | "Y"/"N" — whether this is the portal-owner company. |
Originator Id text | originator_id | External system identifier that created the record. |
Origin Id text | origin_id | External record identifier in the originating system. |
Origin Version text | origin_version | Version of the originating external record. |
Address text | address | Physical address, line 1. |
Address 2 text | address_2 | Physical address, line 2. |
Address City text | address_city | City. |
Address Postal Code text | address_postal_code | Postal code. |
Address Region text | address_region | Region / state. |
Address Province text | address_province | Province. |
Address Country text | address_country | Country name. |
Address Country Code text | address_country_code | ISO country code. |
Address Loc Addr Id text | address_loc_addr_id | Internal Bitrix24 location-address ID. |
Address Legal text | address_legal | Legal address. |
Reg Address text | reg_address | Registered address, line 1. |
Reg Address 2 text | reg_address_2 | Registered address, line 2. |
Reg Address City text | reg_address_city | Registered city. |
Reg Address Postal Code text | reg_address_postal_code | Registered postal code. |
Reg Address Region text | reg_address_region | Registered region. |
Reg Address Province text | reg_address_province | Registered province. |
Reg Address Country text | reg_address_country | Registered country. |
Reg Address Country Code text | reg_address_country_code | Registered country ISO code. |
Reg Address Loc Addr Id text | reg_address_loc_addr_id | Internal Bitrix24 registered-location-address ID. |
Utm Source text | utm_source | UTM source marker. |
Utm Medium text | utm_medium | UTM medium marker. |
Utm Campaign text | utm_campaign | UTM campaign marker. |
Utm Content text | utm_content | UTM content marker. |
Utm Term text | utm_term | UTM term marker. |
Last Activity By text | last_activity_by | ID of the user who performed the last activity. |
Last Activity Time datetime | last_activity_time | Timestamp of the last activity on the record. |
Last Communication Time datetime | last_communication_time | Timestamp of the last communication. |
Phone structure | phone | Multi-valued phone list. Each element carries VALUE_TYPE (WORK/MOBILE/HOME/...), VALUE (number), and TYPE_ID=PHONE. |
Email structure | email | Multi-valued email list. Each element: VALUE_TYPE, VALUE (address), TYPE_ID=EMAIL. |
Web structure | web | Multi-valued website list. Each element: VALUE_TYPE, VALUE (URL), TYPE_ID=WEB. |
Im structure | im | Multi-valued IM / messenger list. Each element: VALUE_TYPE (SKYPE/TELEGRAM/WHATSAPP/...), VALUE (handle), TYPE_ID=IM. |
Custom fields values structure | custom_fields_values | User-defined fields (UF_CRM_*) from Bitrix24 admin panel. Each element carries the Bitrix24 field key and its serialized value. Metadata fields field_id / field_name / field_type are populated from crm.{entity}.userfield.list at pipeline start. is_computed stays NULL (Bitrix24 has no equivalent). |
Partition Date · Required date | partition_date | Creation day derived from DATE_CREATE, truncated to a date. Partition key of the destination table: day granularity keeps the incremental MERGE cheap and its partition list small. |
| Name | API name | Description |
|---|---|---|
Id · Required text | id | Unique identifier. |
Owner Id text | owner_id | ID of the CRM entity the activity is bound to. |
Owner Type Id text | owner_type_id | Entity type the activity is bound to: 1=lead, 2=deal, 3=contact, 4=company. |
Type Id text | type_id | Type code. |
Provider Id text | provider_id | Activity provider code (CRM_TODO, CRM_CALL, ...). |
Provider Type Id text | provider_type_id | Provider sub-type code. |
Provider Group Id text | provider_group_id | Provider group code. |
Associated Entity Id text | associated_entity_id | ID of the related entity produced by the activity. |
Subject text | subject | Activity subject line. |
Created datetime | created | Activity creation timestamp. |
Last Updated · Required datetime | last_updated | Last update timestamp (used as incremental filter field). |
Start Time datetime | start_time | Activity start timestamp. |
End Time datetime | end_time | Activity end timestamp. |
Deadline datetime | deadline | Activity deadline. |
Completed text | completed | "Y"/"N" — completion flag. |
Status text | status | Activity status code. |
Responsible Id text | responsible_id | ID of the user responsible for the activity. |
Priority text | priority | Priority code. |
Notify Type text | notify_type | Notification type code. |
Notify Value text | notify_value | Notification value. |
Description text | description | Activity description. |
Description Type text | description_type | Description format type code. |
Direction text | direction | Direction code: 0=none, 1=incoming, 2=outgoing. |
Location text | location | Activity location. |
Settings json | settings | Provider-specific settings payload (dynamic keys). |
Originator Id text | originator_id | External system identifier that created the record. |
Origin Id text | origin_id | External record identifier in the originating system. |
Author Id text | author_id | ID of the activity author. |
Editor Id text | editor_id | ID of the user who last edited the activity. |
Provider Params json | provider_params | Provider-specific parameters (heterogeneous list/object). |
Provider Data text | provider_data | Provider-specific raw data. |
Result Mark text | result_mark | Result mark code. |
Result Value text | result_value | Result numeric value. |
Result Sum text | result_sum | Result monetary amount. |
Result Currency Id text | result_currency_id | Result currency ISO code. |
Result Status text | result_status | Result status code. |
Result Stream text | result_stream | Result stream code. |
Result Source Id text | result_source_id | Source ID inside the result object. |
Autocomplete Rule text | autocomplete_rule | Autocomplete rule code. |
Partition Date · Required date | partition_date | Creation day derived from CREATED, truncated to a date. Partition key of the destination table: day granularity keeps the incremental MERGE cheap and its partition list small. |
| Name | API name | Description |
|---|---|---|
Id text | id | Unique identifier. |
Xml Id text | xml_id | External system identifier. |
Active bool | active | Whether the user account is active. |
Name text | name | First name. |
Last Name text | last_name | Last name. |
Email text | email | Primary email address. |
Last Login datetime | last_login | Timestamp of the last login. |
Date Register datetime | date_register | Date the user registered on the portal. |
Time Zone text | time_zone | User timezone name (IANA). |
Is Online text | is_online | "Y"/"N" — online presence flag. |
Timestamp X json | timestamp_x | Record version timestamp wrapped by Bitrix24 (heterogeneous dict). |
Last Activity Date json | last_activity_date | Last activity timestamp per department (heterogeneous dict). |
Personal Gender text | personal_gender | Gender code (M/F/""). |
Personal Birthday text | personal_birthday | Birth date (YYYY-MM-DD or empty string). |
Uf Employment Date datetime | uf_employment_date | User-field: employment date. |
Uf Department array_int | uf_department | Array of department IDs the user belongs to. |
User Type text | user_type | User type code (employee / extranet / ...). |
| Name | API name | Description |
|---|---|---|
Id text | id | Unique identifier. |
Created Date datetime | created_date | Pipeline creation timestamp. |
Name text | name | First name. |
Sort text | sort | Sort order weight (ascending). |
Is Locked text | is_locked | "Y"/"N" — pipeline is locked from editing. |
| Name | API name | Description |
|---|---|---|
Id text | id | Unique identifier. |
Entity Id text | entity_id | Directory entity ID (e.g. STATUS, SOURCE, DEAL_STAGE_0). |
Status Id text | status_id | Current status code. |
Name text | name | First name. |
Name Init text | name_init | Original name before localization. |
Sort text | sort | Sort order weight (ascending). |
System text | system | "Y"/"N" — whether the status is system-owned. |
Color text | color | Color hex code for UI rendering. |
Semantics text | semantics | Semantic code (success/failure/in-progress) or null. |
Category Id text | category_id | Pipeline (deal category) ID. |
| Name | API name | Description |
|---|---|---|
Currency text | currency | ISO currency code (primary key). |
Amount Cnt text | amount_cnt | Amount-per-unit multiplier. |
Amount text | amount | Exchange rate relative to the base currency. |
Sort text | sort | Sort order weight (ascending). |
Base text | base | "Y"/"N" — whether this is the base currency of the portal. |
Full Name text | full_name | Full localized name of the currency. |
Lid text | lid | Locale ID used for the full name. |
Format String text | format_string | Formatting template for amount rendering. |
Dec Point text | dec_point | Decimal separator character. |
Thousands Sep text | thousands_sep | Thousands separator (HTML-encoded). |
Decimals text | decimals | Number of decimal places. |
Date Update datetime | date_update | Timestamp of the last rate update. |
| Name | API name | Description |
|---|---|---|
Id text | id | Bitrix24 userfield numeric ID (primary key within entity_id scope). |
Entity Id text | entity_id | CRM entity the userfield belongs to: CRM_DEAL, CRM_LEAD, CRM_CONTACT, CRM_COMPANY. |
Field Name text | field_name | Field key used in crm.{entity}.list responses (e.g. UF_CRM_1234567890). |
User Type Id text | user_type_id | Userfield type code: string, integer, enumeration, datetime, boolean, double, file, employee, iblock_section, ... |
Xml Id text | xml_id | External-system identifier of the userfield. |
Sort text | sort | Sort order weight (ascending). |
Multiple text | multiple | "Y"/"N" — whether the field accepts multiple values. |
Mandatory text | mandatory | "Y"/"N" — whether the field is required when creating/updating the record. |
Show Filter text | show_filter | How the field appears in filters: "N" hidden, "I" exact match, "E" substring, "Y" default. |
Show In List text | show_in_list | "Y"/"N" — whether the field is displayed in the list view. |
Edit In List text | edit_in_list | "Y"/"N" — whether inline editing is allowed in the list view. |
Is Searchable text | is_searchable | "Y"/"N" — whether the field participates in full-text search. |
Edit Form Label text | edit_form_label | Human-readable label shown on the edit form (localized via filter.LANG). |
List Column Label text | list_column_label | Column header label in the list view (localized). |
List Filter Label text | list_filter_label | Label shown above the field in filter UI. |
Error Message text | error_message | Custom validation error message (localized). |
Help Message text | help_message | Help tooltip text (localized). |
User Type Owner text | user_type_owner | Identifier of the marketplace app that registered a custom user_type_id (present only for app-defined types). |
Settings json | settings | Type-specific configuration payload (e.g. list display mode, default value, min/max). Raw JSON object. |
List json | list | Enumeration values (only present for user_type_id='enumeration'). Each element has ID, VALUE, SORT, DEF (default flag), XML_ID. |
To enable incremental loading for deals, leads, contacts, companies, and activities, include the date_modify (or last_updated for activities) parameter. Without this field, Renta will perform a full snapshot on every run.
Date range
You can limit the volume of extracted data instead of exporting all your records (for example, all leads). In the Date range, specify a period, and Renta will filter the data based on the DATE_MODIFY field. For instance, if you only need leads that were updated after a specific date, you can use Date range for this.
Sync strategy
The table below describes how Renta synchronizes each Bitrix24 report type.
| Strategy | Supported report types | Description |
|---|---|---|
| Incremental (merge) | Deals, Leads, Contacts, Companies, Activities | Renta fetches only records modified since the last successful run, using the Bitrix24 DATE_MODIFY filter. Records are upserted into the destination table by their unique id. A 3-hour safety overlap is applied to the fetch window to account for Bitrix24 replication lag — duplicate records are automatically collapsed at the destination. |
| Full snapshot | Users, Deal categories, Deal stages, Currencies, Userfields | These tables represent configuration dictionaries that have no modification-date field. Renta reloads the full dataset on every run. The tables are small (typically fewer than 500 rows) so the performance impact is negligible. |
Incremental loading requires a merge-capable destination such as Google BigQuery or ClickHouse. When connected to other destinations, Renta falls back to a full overwrite of the selected date range.
Custom fields
Bitrix24 allows portal administrators to add user-defined fields (prefixed UF_CRM_) to deals, leads, contacts, and companies. Renta captures all user-defined fields automatically — no manual schema configuration is required.
User-defined field values are stored in the custom_fields_values column as a structured array. Each entry in the array contains:
| Subfield | Description |
|---|---|
| field_code | The Bitrix24 internal field key, such as UF_CRM_1719402824087. |
| field_name | The human-readable label configured in the Bitrix24 admin panel, such as "Lead quality score". |
| field_type | The field data type as defined in Bitrix24: string, integer, enumeration, boolean, datetime, etc. |
| field_value | The field value for this record, stored as a text string. List values are serialized as JSON. |
| field_id | The numeric ID of the field definition. |
| is_computed | Indicates whether the field is computed automatically by Bitrix24. |
To query user-defined fields in BigQuery, unnest the array and filter by field code or name:
SELECT
id,
title,
cf.field_name AS custom_label,
cf.field_value AS custom_value,
cf.field_type AS custom_type
FROM `project.dataset.deals` d,
UNNEST(custom_fields_values) AS cf
WHERE cf.field_name = 'Lead quality score';The userfields report type exports a separate reference table that maps every UF_CRM_* key to its label, type, and — for enumeration fields — the full list of allowed values. Join this table with custom_fields_values to decode numeric enum IDs into human-readable labels.
Multi-value fields
For leads, contacts, and companies, Bitrix24 stores phone numbers, email addresses, website links, and messenger accounts as multi-value fields. Renta exports each of these as a structured array column.
| Column | Contains |
|---|---|
| phone | Phone numbers with value and type (Work, Home, Mobile, Fax, etc.). |
| Email addresses with value and type (Work, Home, etc.). | |
| web | Website URLs with value and type (Work, Home, Facebook, etc.). |
| im | Messenger account IDs with value and type (Telegram, WhatsApp, Skype, etc.). |
To extract all work phone numbers for leads in BigQuery:
SELECT
id,
title,
p.value AS phone_number
FROM `project.dataset.leads` l,
UNNEST(phone) AS p
WHERE p.value_type = 'WORK';Sync scheduling
Renta supports automatic scheduling, API triggers, and integration with external orchestrators such as Apache Airflow, Dagster, and Prefect. See the scheduling documentation for details.
Ready to get started?
Build your data pipeline today or get a personalized demo. Start free!
Need help?
Get expert support to ensure your project succeeds. We're here to help!
Feature requests?
Help shape our product! Share your ideas for new features and integrations.