Where do I find my KeyCRM API key?

In KeyCRM, open **Settings** > **General**, find the **API key** row, and click **Generate API key**. The key belongs to the whole CRM account, and only the account owner can regenerate it.

What happens when the API key is regenerated in KeyCRM?

The previous value stops working the moment a new one is issued, and runs fail with a message saying that access to the KeyCRM account has been revoked. Open the source in the **Sources** section, paste the new value into the **API key** field, and save.

Can one pipeline export several report types?

No. A pipeline carries one report type, so create a separate pipeline for each KeyCRM object you want in the warehouse.

Does the pipeline load only the records changed since the previous run?

No. Every run reads the object in full and replaces the destination table, so the table always repeats the KeyCRM account at the time of the run.

Do several KeyCRM pipelines slow each other down?

Yes. KeyCRM counts 60 requests per minute for the entire account, and every pipeline built on the same API key draws from that budget. Runs scheduled at the same hour take longer than the same runs spread out.

KeyCRM

Renta loads a KeyCRM account into your data warehouse as eight report types: orders, buyers, the companies those buyers belong to, products, the offers a product splits into, sales pipelines, account users, and the definitions of the custom fields configured in the account.

An order arrives with its money broken out: product total, shipping and wrap price, discounts, taxes, expenses, margin, payments, and grand total. The same row carries the payment and fiscal status and the times the order was placed, closed, and last changed status. Products and offers add stock and reserve quantities to their prices, barcodes, and dimensions.

You pick the fields of each report type yourself. Every report type reloads in full on each run, so the destination table repeats the KeyCRM account as it was when the run started.

Authentication

Renta connects to KeyCRM with the account's Open API key. KeyCRM issues one key for the whole CRM account rather than one per user, so a pipeline reaches everything the account holds.

To get the key, open Settings > General in KeyCRM, find the API key row, and click Generate API key.

Only the account owner can regenerate the key. A new value replaces the old one immediately, and every integration still holding the old value stops working until you paste the new one into its connection.

Connect KeyCRM source

Follow these steps to add KeyCRM as a source in Renta using the account's Open API key.

Go to the CatalogStep 1

Navigate to the Connections > Catalog section in the left sidebar.
Open the CRM category and click the KeyCRM card.

KeyCRM card in the CRM category of the Renta connection catalog

Paste the API keyStep 2

In the API key field, paste the Open API key of your KeyCRM account.

To find it, open Settings > General in KeyCRM and copy the value from the API key row.

Add a new KeyCRM connection page with the API key field

Name the connection and saveStep 3

In the Source name field, specify a name for this data source. It is used exclusively in the Renta interface.
Click Save.

Renta checks the key with KeyCRM before saving the connection, so a mistyped or already replaced key fails right on this step.

KeyCRM connection setup with the source name field filled in and the Save button

Source createdStep 4

The new source appears in the Sources list with the Active status. You can now use it in pipelines.

Sources list with the new KeyCRM source in the Active status

Create a pipeline

Once the source is connected, create a pipeline to sync your KeyCRM data into your destination.

Create a KeyCRM pipeline

Link your KeyCRM source to a destination and configure the pipeline.

Select KeyCRM as the sourceStep 1

In the left sidebar, click New pipeline. On the Source step, select KeyCRM under Already connected and click Next step.

Select a source step with KeyCRM under Already connected

Select your KeyCRM connectionStep 2

Choose the KeyCRM connection you created earlier and click Next step. The card shows the name of the connection and the date it was added.

Select your KeyCRM connection step with the connection card and its creation date

Select a destinationStep 3

On the Destination step, select your destination (for example, Google BigQuery) and click Next step.

Select a destination step with Google BigQuery under Already connected

Select the destination connectionStep 4

Choose the destination connection you want to load data into and click Next step. The card shows the dataset and project the data will land in.

Select your Google BigQuery connection step with the dataset and project identifiers on the card

Pipeline configuration

On the final step, choose the report, pick its fields, and set the schedule.

Report type

Select which KeyCRM object the pipeline exports. One pipeline loads one report type.

Report type	Description
Buyers	Customers with their full name, birthday, email addresses and phone numbers, the manager and company assigned to them, currency and personal discount, the number and total sum of their orders, and a duplicate flag.
Companies	Companies attached to buyers: name, title, address, account details, assigned manager, and notes.
Custom Fields	Definitions of the custom fields configured in the account: name, type, the model the field belongs to, its position, and whether it is required or accepts several values.
Offers	The individual variants a product splits into: price and purchase price, stock and reserved quantity, barcode and SKU, weight and dimensions, the properties that tell one variant from another, and the archived and default flags.
Orders	Orders with their buyer, status and status group, the source they came from, promo code, payment and fiscal status, product total, shipping and wrap price, discounts, taxes, expenses, margin, payments and grand total, buyer, client and manager comments, gift flags, and the times the order was placed, closed, and last changed status.
Pipelines	Sales pipelines: title, lead type, position in the list, and whether the pipeline uses payments and products.
Products	The product catalog: name, category, description, price range and purchase price, currency, stock and reserved quantity, barcode and SKU, unit type, weight and dimensions, image links, the sales channels the product is listed in, and the archived flag.
Users	Account users with their email, username, first, last and full name, phone, role, status, and the time they last logged in.

Parameters

Select the KeyCRM fields to include in the destination table.

Each entry on the KeyCRM fields tab shows the field name and, below it, the column name it takes in the destination table. Use the search field to find a parameter by name, or click Select All. The Selected tab shows everything you picked, and the Selected Parameters list below the picker lets you remove a parameter.

The set of available fields depends on the report type, and no field is picked for you. Add ID to every pipeline: it identifies a record between runs.

KeyCRM returns related records as identifiers rather than as names. Load the matching report type to resolve them.

Identifier	Report type that resolves it
Client ID in Orders	Buyers
Company ID in Buyers	Companies
Manager ID in Buyers and Companies	Users
Product ID in Offers	Products

Fields that hold several values at once load as list columns rather than as extra rows.

Report type	Fields that load as list columns
Buyers	Email, Phone
Offers	Properties
Orders	Fiscal Result
Products	Attachments Data, Sources

The Custom Fields report type describes the custom fields set up in the account: their name, type, and the model they belong to, such as an order or a buyer. Values stored on individual records are not among the parameters of the object report types.

Table name

Name the pipeline and the destination table.

Integration name.
The name of the pipeline. It is used exclusively in the Renta interface.
Table name.
The destination table name. You can keep the auto-generated name or enter your own.

Schedule

Choose how often the pipeline runs.

Schedule type	Description
Manual	The pipeline runs only when triggered manually through the interface or via API.
Daily	The pipeline runs once a day at the specified update time.
Interval	The pipeline runs at specified time intervals.
Cron Expression	The pipeline runs on a schedule defined by a cron expression.

For Daily schedules, set the Update time, the exact time each run starts, then click Create pipeline.

Update time selection and the Create pipeline button

KeyCRM allows 60 requests per minute for the whole account, and Renta stays inside that limit. A long order history or a large catalog takes noticeably longer to load because of it, and pipelines scheduled at the same hour draw from the same budget.

Renta also supports API triggers and integration with external orchestrators such as Apache Airflow, Dagster, and Prefect. See the full scheduling documentation for details.

The new pipeline appears in the Pipelines section under the ETL tab, where you can track its runs, progress, and the destination table name.

Pipelines list with the new KeyCRM integration in the Completed status

Sync strategy

Renta synchronizes every KeyCRM report type the same way.

Strategy	Supported report types	Description
Full reload	Buyers, Companies, Custom Fields, Offers, Orders, Pipelines, Products, Users	Renta reads the object in full on every run and replaces the contents of the destination table. The table repeats the KeyCRM account at the time of the run, and a record that KeyCRM stops returning leaves the table on the next run.

Because every run reads the object in full, the pipeline has no date range or overwrite period settings. KeyCRM report types also carry no date parameter to partition by, so destination tables stay unpartitioned.

Frequently asked questions

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.