Where do I find my Pipedrive API key?

In Pipedrive, open your account name in the top right corner, then **Company settings** > **Personal preferences** > **API**. The key is issued per user and per company, so a user who belongs to several Pipedrive companies has a separate key for each of them.

Why does a run fail with the message that the endpoint is not available for the account plan?

Pipedrive gives access to some objects only on certain plans. While the object is not included in your plan, Pipedrive answers the request with an error and the run stops. Pick another report type or upgrade the Pipedrive plan.

How do I turn custom field keys into readable names?

Create a pipeline for the Deal Fields , Person Fields , Organization Fields , or Product Fields report type. Each row carries the field Key and its Name , so you can join it with the keys inside the Custom Fields column.

Can one pipeline export several report types?

No. A pipeline carries one report type, so create a separate pipeline for each Pipedrive 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 mirrors the Pipedrive account at the time of the run.

Pipedrive

Renta exports a Pipedrive account to your data warehouse as 26 report types: deals, leads, persons, organizations, products, and other objects of the account.

The remaining report types describe the account itself: pipelines and stages, users and their permissions, and the definitions of system and custom fields.

Authentication

Renta connects to Pipedrive with a personal API key. You copy the key from your Pipedrive settings and paste it into the connection form.

The key carries the permissions of the user it belongs to, so a pipeline loads the records that this user sees in Pipedrive. To export everything the company has, take the key of a user with full access.

Connect Pipedrive source

Go to the CatalogStep 1

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

Pipedrive card in the CRM category of the Renta catalog

Paste the API keyStep 2

In the API key field, paste your personal Pipedrive API key.

To find it, open your account name in the top right corner of Pipedrive, then Company settings > Personal preferences > API.

Add a new Pipedrive 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 Pipedrive before saving the connection, so an invalid or revoked key fails right on this step.

Pipedrive connection setup with the source name field 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 Pipedrive source in the Active status

Create a Pipedrive pipeline

Select Pipedrive as the sourceStep 1

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

Select a source step with Pipedrive under Already connected

Select your Pipedrive connectionStep 2

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

Select your Pipedrive 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 Pipedrive object the pipeline exports. One pipeline loads one report type.

Report type	Description
Activities	Calls, meetings, and tasks with their type, due date, duration, and done state, the record they belong to, and the meeting location broken down into street, locality, and country.
Activity Types	Activity types configured in the account: name, icon, color, and order.
Call Logs	Logged calls: outcome, duration, both phone numbers, start and end time, and the linked activity, person, organization, deal, or lead.
Currencies	Currencies available in the account, with their code, symbol, and decimal precision.
Deal Fields	Definitions of every deal field, system and custom: key, name, field type, and behavior flags.
Deals	Deals with their value, currency, stage, status, and probability. Each row also carries the won, lost, and close times, counters of related activities, files, and emails, the linked person and organization, and custom field values.
Files	Files attached to records: name, size, type, storage location, and the record they belong to.
Filters	Saved filters: type, visibility, owner, and the time each one was last used.
Goals	Company, team, and user goals: expected outcome, period, pipeline, stage, and the progress report.
Lead Sources	The lead sources available in the account.
Leads	Leads with their value and currency, expected close date, source, origin and channel, the linked person and organization, and the archive state.
Legacy Teams	Teams with their manager, member list, and active member count.
Mailbox	Mail threads: subject, snippet, parties, folders, message counts, read and attachment flags, and the linked deal, lead, or project.
Notes	Notes with their content, author, pinned flags, and the record they belong to.
Organization Fields	Definitions of every organization field, system and custom.
Organizations	Organizations with the address broken into components, industry, annual revenue, employee count, owner, and counters of open, won, and lost deals.
Permission Sets	Permission sets: type, app, and number of assignments.
Person Fields	Definitions of every person field, system and custom.
Persons	Persons with their phone numbers, emails, and messenger handles, postal address, job title, owner, linked organization, deal counters, and custom field values.
Pipelines	Pipelines: order, default deal probability, and active flag.
Product Fields	Definitions of every product field, system and custom.
Products	Products with their code, unit, tax, category, billing frequency, and the price list per currency.
Roles	Roles: parent role, level, description, and number of assignments.
Stages	Stages with the pipeline they belong to, their order, deal probability, and rotten-deal settings.
User Settings	Settings of the account the API key belongs to: default currency, fiscal year, duplicate conditions, email sync rules, and notification preferences.
Users	Users with their email, language, time zone, role, admin and active flags, and access rights per feature.

Pipedrive opens some objects only on certain plans. If your plan does not include the object behind the selected report type, the run stops with an error stating that the endpoint is not available for the account plan.

Parameters

Select the Pipedrive fields to include in the destination table.

Report type

Name	API name	Description
ID int	`id`	Unique identifier of the activity.
User ID int	`user_id`	ID of the user who owns the activity.
Done bool	`done`	Whether the activity is marked as done.
Type text	`type`	Type key of the activity (e.g. task, call, meeting).
Reference Type text	`reference_type`	Type of the reference entity linked to the activity.
Reference ID int	`reference_id`	ID of the reference entity linked to the activity.
Conference Meeting Client text	`conference_meeting_client`	Conference meeting client used for the activity.
Conference Meeting URL text	`conference_meeting_url`	URL of the conference meeting.
Due Date date	`due_date`	Due date of the activity.
Due Time text	`due_time`	Due time of the activity.
Duration text	`duration`	Duration of the activity.
Busy Flag bool	`busy_flag`	Whether the user is marked as busy during the activity.
Add Time datetime	`add_time`	Date and time when the activity was created.
Marked As Done Time datetime	`marked_as_done_time`	Date and time when the activity was marked as done.
Last Notification Time datetime	`last_notification_time`	Date and time of the last notification sent.
Last Notification User ID int	`last_notification_user_id`	ID of the user who received the last notification.
Notification Language ID int	`notification_language_id`	ID of the language used for notifications.
Subject text	`subject`	Subject of the activity.
Public Description text	`public_description`	Public description of the activity.
Calendar Sync Include Context text	`calendar_sync_include_context`	Whether to include context when syncing with calendar.
Location text	`location`	Location of the activity.
Org ID int	`org_id`	ID of the organization linked to the activity.
Person ID int	`person_id`	ID of the person linked to the activity.
Deal ID int	`deal_id`	ID of the deal linked to the activity.
Lead ID text	`lead_id`	ID of the lead linked to the activity.
Project ID int	`project_id`	ID of the project linked to the activity.
Active Flag bool	`active_flag`	Whether the activity is active.
Update Time datetime	`update_time`	Date and time when the activity was last updated.
Update User ID int	`update_user_id`	ID of the user who last updated the activity.
Source Timezone text	`source_timezone`	Timezone of the activity source.
Rec Rule text	`rec_rule`	Recurrence rule for the activity.
Rec Rule Extension text	`rec_rule_extension`	Extension of the recurrence rule.
Rec Master Activity ID int	`rec_master_activity_id`	ID of the master recurring activity.
Conference Meeting ID text	`conference_meeting_id`	ID of the conference meeting.
Original Start Time datetime	`original_start_time`	Original start time of the activity (for recurring events).
Private bool	`private`	Whether the activity is private.
Priority int	`priority`	Priority level of the activity.
Note text	`note`	Note/description content of the activity.
Created By User ID int	`created_by_user_id`	ID of the user who created the activity.
Location Subpremise text	`location_subpremise`	Subpremise part of the activity location.
Location Street Number text	`location_street_number`	Street number of the activity location.
Location Route text	`location_route`	Route/street of the activity location.
Location Sublocality text	`location_sublocality`	Sublocality of the activity location.
Location Locality text	`location_locality`	Locality/city of the activity location.
Location Admin Area Level 1 text	`location_admin_area_level_1`	Administrative area level 1 of the activity location.
Location Admin Area Level 2 text	`location_admin_area_level_2`	Administrative area level 2 of the activity location.
Location Country text	`location_country`	Country of the activity location.
Location Postal Code text	`location_postal_code`	Postal code of the activity location.
Location Formatted Address text	`location_formatted_address`	Full formatted address of the activity location.
Attendees json	`attendees`	List of attendees of the activity.
Participants structure	`participants`	List of participants linked to the activity.
Series json	`series`	Series data for recurring activities.
Is Recurring bool	`is_recurring`	Whether the activity is recurring.
Org Name text	`org_name`	Name of the linked organization.
Person Name text	`person_name`	Name of the linked person.
Deal Title text	`deal_title`	Title of the linked deal.
Lead Title text	`lead_title`	Title of the linked lead.
Project Title text	`project_title`	Title of the linked project.
Owner Name text	`owner_name`	Name of the owner of the activity.
Person Dropbox BCC text	`person_dropbox_bcc`	BCC email address for the linked person's dropbox.
Deal Dropbox BCC text	`deal_dropbox_bcc`	BCC email address for the linked deal's dropbox.
Assigned To User ID int	`assigned_to_user_id`	ID of the user the activity is assigned to.
Type Name text	`type_name`	Human-readable name of the activity type.
Lead json	`lead`	Lead data linked to the activity.
Company ID int	`company_id`	ID of the company account.

Name	API name	Description
ID int	`id`	Unique identifier of the activity type.
Order Nr int	`order_nr`	Order number used for sorting activity types.
Name text	`name`	Name of the activity type.
Key String text	`key_string`	Unique key string identifier of the activity type.
Icon Key text	`icon_key`	Key of the icon used for the activity type.
Active Flag bool	`active_flag`	Whether the activity type is active.
Color text	`color`	Color associated with the activity type.
Is Custom Flag bool	`is_custom_flag`	Whether the activity type is custom (user-defined).
Add Time datetime	`add_time`	Date and time when the activity type was created.
Update Time datetime	`update_time`	Date and time when the activity type was last updated.

Name	API name	Description
ID text	`id`	Unique identifier of the call log.
User ID int	`user_id`	ID of the user associated with the call log.
Activity ID int	`activity_id`	ID of the activity linked to the call log.
Subject text	`subject`	Subject/title of the call log.
Duration text	`duration`	Duration of the call in seconds.
Outcome text	`outcome`	Outcome of the call (e.g. connected, no_answer).
From Phone Number text	`from_phone_number`	Phone number from which the call was made.
To Phone Number text	`to_phone_number`	Phone number to which the call was made.
Start Time datetime	`start_time`	Start date and time of the call.
End Time datetime	`end_time`	End date and time of the call.
Person ID int	`person_id`	ID of the person linked to the call log.
Org ID int	`org_id`	ID of the organization linked to the call log.
Deal ID int	`deal_id`	ID of the deal linked to the call log.
Lead ID text	`lead_id`	ID of the lead linked to the call log.
Note text	`note`	Note associated with the call log.
Add Time datetime	`add_time`	Date and time when the call log was created.
Update Time datetime	`update_time`	Date and time when the call log was last updated.
Has Recording bool	`has_recording`	Whether the call has a recording.
Company ID int	`company_id`	ID of the company account.

Name	API name	Description
ID int	`id`	Unique identifier of the currency.
Code text	`code`	ISO currency code (e.g. USD, EUR).
Name text	`name`	Full name of the currency.
Symbol text	`symbol`	Currency symbol.
Decimal Points int	`decimal_points`	Number of decimal places for the currency.
Active Flag bool	`active_flag`	Whether the currency is active.
Is Custom Flag bool	`is_custom_flag`	Whether the currency is custom (user-defined).

Name	API name	Description
ID int	`id`	Unique identifier of the field definition.
Key text	`key`	API key for the field. Custom fields have a 40-character hex key; system fields use readable names.
Name text	`name`	Human-readable name of the field.
Field Type text	`field_type`	Data type of the field (e.g. varchar, int, date, enum).
Add Time datetime	`add_time`	Date and time when the field was created.
Update Time datetime	`update_time`	Date and time when the field was last updated.
Edit Flag bool	`edit_flag`	Whether the field value can be edited.
Add Visible Flag bool	`add_visible_flag`	Whether the field is visible in the add item form.
Active Flag bool	`active_flag`	Whether the field is active.
Filtering Allowed bool	`filtering_allowed`	Whether filtering by this field is allowed.
Sortable Flag bool	`sortable_flag`	Whether the list can be sorted by this field.
Mandatory Flag bool	`mandatory_flag`	Whether this field is mandatory when creating a deal.
Searchable Flag bool	`searchable_flag`	Whether this field is included in search.
Bulk Edit Allowed bool	`bulk_edit_allowed`	Whether this field can be edited in bulk.
JSON Column Flag bool	`json_column_flag`	Whether this field is stored as a JSON column.
Show In Pipelines json	`show_in_pipelines`	Pipeline visibility settings for this field.

Name	API name	Description
ID int	`id`	Unique identifier of the deal.
Creator User ID int	`creator_user_id_value`	ID of the user who created the deal (extracted from creator_user_id.value).
Creator User Name text	`creator_user_id_name`	Name of the user who created the deal.
Creator User Email text	`creator_user_id_email`	Email of the user who created the deal.
User ID int	`user_id_value`	ID of the user owning the deal (extracted from user_id.value).
User Name text	`user_id_name`	Name of the user owning the deal.
User Email text	`user_id_email`	Email of the user owning the deal.
Person ID int	`person_id_value`	ID of the person linked to the deal (extracted from person_id.value).
Person Name text	`person_id_name`	Name of the person linked to the deal.
Org ID int	`org_id_value`	ID of the organization linked to the deal (extracted from org_id.value).
Org Name text	`org_id_name`	Name of the organization linked to the deal.
Org Address text	`org_id_address`	Address of the organization linked to the deal.
Stage ID int	`stage_id`	ID of the pipeline stage the deal is in.
Title text	`title`	Title of the deal.
Value decimal	`value`	Monetary value of the deal.
ACV decimal	`acv`	Annual contract value of the deal.
MRR decimal	`mrr`	Monthly recurring revenue of the deal.
ARR decimal	`arr`	Annual recurring revenue of the deal.
Currency text	`currency`	Currency code of the deal value.
Add Time datetime	`add_time`	Date and time when the deal was created.
Update Time datetime	`update_time`	Date and time when the deal was last updated.
Stage Change Time datetime	`stage_change_time`	Date and time when the deal last changed stage.
Active bool	`active`	Whether the deal is active.
Deleted bool	`deleted`	Whether the deal has been deleted.
Status text	`status`	Status of the deal (open, won, lost).
Probability decimal	`probability`	Probability of winning the deal (percentage).
Next Activity Date date	`next_activity_date`	Date of the next scheduled activity for the deal.
Next Activity Time text	`next_activity_time`	Time of the next scheduled activity.
Next Activity ID int	`next_activity_id`	ID of the next scheduled activity.
Last Activity ID int	`last_activity_id`	ID of the last completed activity.
Last Activity Date date	`last_activity_date`	Date of the last completed activity.
Lost Reason text	`lost_reason`	Reason for losing the deal.
Visible To text	`visible_to`	Visibility setting of the deal.
Close Time datetime	`close_time`	Date and time when the deal was closed.
Pipeline ID int	`pipeline_id`	ID of the pipeline the deal belongs to.
Won Time datetime	`won_time`	Date and time when the deal was marked as won.
First Won Time datetime	`first_won_time`	Date and time when the deal was first marked as won.
Lost Time datetime	`lost_time`	Date and time when the deal was marked as lost.
Products Count int	`products_count`	Number of products linked to the deal.
Files Count int	`files_count`	Number of files attached to the deal.
Notes Count int	`notes_count`	Number of notes on the deal.
Followers Count int	`followers_count`	Number of followers of the deal.
Email Messages Count int	`email_messages_count`	Number of email messages linked to the deal.
Activities Count int	`activities_count`	Total number of activities for the deal.
Done Activities Count int	`done_activities_count`	Number of completed activities.
Undone Activities Count int	`undone_activities_count`	Number of pending activities.
Participants Count int	`participants_count`	Number of participants in the deal.
Expected Close Date date	`expected_close_date`	Expected close date of the deal.
Last Incoming Mail Time datetime	`last_incoming_mail_time`	Date and time of the last incoming email.
Last Outgoing Mail Time datetime	`last_outgoing_mail_time`	Date and time of the last outgoing email.
Label text	`label`	Label ID assigned to the deal.
Local Won Date date	`local_won_date`	Local date when the deal was won.
Local Lost Date date	`local_lost_date`	Local date when the deal was lost.
Local Close Date date	`local_close_date`	Local date when the deal was closed.
Origin text	`origin`	Origin of how the deal was created.
Origin ID text	`origin_id`	ID of the origin entity.
Channel int	`channel`	Channel ID through which the deal was created.
Channel ID text	`channel_id`	Channel identifier string.
Is Archived bool	`is_archived`	Whether the deal is archived.
Archive Time datetime	`archive_time`	Date and time when the deal was archived.
Score decimal	`score`	Score assigned to the deal.
Stage Order Nr int	`stage_order_nr`	Order number of the stage.
Person Name (denormalized) text	`person_name`	Name of the linked person (denormalized field).
Org Name (denormalized) text	`org_name`	Name of the linked organization (denormalized field).
Next Activity Subject text	`next_activity_subject`	Subject of the next scheduled activity.
Next Activity Type text	`next_activity_type`	Type of the next scheduled activity.
Next Activity Duration text	`next_activity_duration`	Duration of the next scheduled activity.
Next Activity Note text	`next_activity_note`	Note of the next scheduled activity.
Formatted Value text	`formatted_value`	Deal value formatted with currency symbol.
Weighted Value decimal	`weighted_value`	Weighted value of the deal based on probability.
Formatted Weighted Value text	`formatted_weighted_value`	Weighted value formatted with currency symbol.
Weighted Value Currency text	`weighted_value_currency`	Currency of the weighted value.
Rotten Time datetime	`rotten_time`	Date and time when the deal became rotten.
ACV Currency text	`acv_currency`	Currency of the ACV.
MRR Currency text	`mrr_currency`	Currency of the MRR.
ARR Currency text	`arr_currency`	Currency of the ARR.
Owner Name text	`owner_name`	Name of the deal owner.
CC Email text	`cc_email`	BCC/CC email dropbox address for the deal.
Org Hidden bool	`org_hidden`	Whether the linked organization is hidden.
Person Hidden bool	`person_hidden`	Whether the linked person is hidden.
Custom Fields json	`custom_fields`	Custom field values keyed by 40-character hex field key.

Name	API name	Description
ID int	`id`	Unique identifier of the file.
User ID int	`user_id`	ID of the user who uploaded the file.
Log ID int	`log_id`	ID of the associated log entry.
Add Time datetime	`add_time`	Date and time when the file was uploaded.
Update Time datetime	`update_time`	Date and time when the file record was last updated.
File Name text	`file_name`	Internal file name used for storage.
File Size int	`file_size`	Size of the file in bytes.
Active Flag bool	`active_flag`	Whether the file is active.
Inline Flag bool	`inline_flag`	Whether the file is an inline attachment.
Remote Location text	`remote_location`	Remote storage location (e.g. s3).
Remote ID text	`remote_id`	Remote storage identifier path.
S3 Bucket text	`s3_bucket`	Name of the S3 bucket where the file is stored.
URL text	`url`	Download URL of the file.
Name text	`name`	Display name of the file.
Description text	`description`	Description of the file.
Deal ID int	`deal_id`	ID of the deal the file is attached to.
Lead ID text	`lead_id`	ID of the lead the file is attached to.
Person ID int	`person_id`	ID of the person the file is attached to.
Org ID int	`org_id`	ID of the organization the file is attached to.
Product ID int	`product_id`	ID of the product the file is attached to.
Activity ID int	`activity_id`	ID of the activity the file is attached to.
Deal Name text	`deal_name`	Name of the linked deal.
Lead Name text	`lead_name`	Name of the linked lead.
Person Name text	`person_name`	Name of the linked person.
Org Name text	`org_name`	Name of the linked organization.
Product Name text	`product_name`	Name of the linked product.
Mail Message ID int	`mail_message_id`	ID of the mail message the file is attached to.
Mail Template ID int	`mail_template_id`	ID of the mail template the file is attached to.
CID text	`cid`	Content-ID for inline attachments.
File Type text	`file_type`	File extension/type (e.g. pdf, ics).

Name	API name	Description
ID int	`id`	Unique identifier of the filter.
Name text	`name`	Name of the filter.
Filter Code text	`filter_code`	Internal code key for the filter.
Is Editable bool	`is_editable`	Whether the filter can be edited.
Active Flag bool	`active_flag`	Whether the filter is active.
Type text	`type`	Type of entity the filter applies to (e.g. deals, persons).
Temporary Flag bool	`temporary_flag`	Whether the filter is temporary.
User ID int	`user_id`	ID of the user who created the filter.
Add Time datetime	`add_time`	Date and time when the filter was created.
Update Time datetime	`update_time`	Date and time when the filter was last updated.
Visible To text	`visible_to`	Visibility setting of the filter.
Last Used Time datetime	`last_used_time`	Date and time when the filter was last used.
Custom View ID int	`custom_view_id`	ID of the associated custom view.

Name	API name	Description
ID text	`id`	Unique identifier of the goal.
Title text	`title`	Title of the goal.
Type text	`type`	Type of the goal (e.g. deals_won, revenue).
Assignee ID int	`assignee_id`	ID of the user or team assigned to the goal.
Assignee Type text	`assignee_type`	Type of the assignee (person or team).
Expected Outcome json	`expected_outcome`	Expected outcome target value and unit for the goal.
Duration Start date	`duration_start`	Start date of the goal duration.
Duration End date	`duration_end`	End date of the goal duration.
Pipeline ID int	`pipeline_id`	ID of the pipeline associated with the goal.
Stage ID int	`stage_id`	ID of the stage associated with the goal.
Active bool	`active`	Whether the goal is currently active.
Is Deleted bool	`is_deleted`	Whether the goal has been deleted.
Report json	`report`	Report data associated with the goal.

Name	API name	Description
Name text	`name`	Name of the lead source.

Name	API name	Description
ID text	`id`	Unique identifier of the lead (UUID).
Title text	`title`	Title of the lead.
Owner ID int	`owner_id`	ID of the user who owns the lead.
Creator ID int	`creator_id`	ID of the user who created the lead.
Label IDs json	`label_ids`	List of label IDs assigned to the lead.
Value Amount decimal	`value_amount`	Monetary amount of the lead value (extracted from value.amount).
Value Currency text	`value_currency`	Currency of the lead value (extracted from value.currency).
Expected Close Date date	`expected_close_date`	Expected close date of the lead.
Person ID int	`person_id`	ID of the person linked to the lead.
Organization ID int	`organization_id`	ID of the organization linked to the lead.
Is Archived bool	`is_archived`	Whether the lead is archived.
Archive Time datetime	`archive_time`	Date and time when the lead was archived.
Source Name text	`source_name`	Name of the source from which the lead originated.
Source Deal ID int	`source_deal_id`	ID of the deal that is the source of this lead.
Origin text	`origin`	Origin type of the lead creation.
Origin ID text	`origin_id`	ID of the origin entity.
Channel int	`channel`	Channel ID through which the lead was created.
Channel ID text	`channel_id`	Channel identifier string.
Was Seen bool	`was_seen`	Whether the lead has been viewed.
Next Activity ID int	`next_activity_id`	ID of the next scheduled activity.
Add Time datetime	`add_time`	Date and time when the lead was created.
Update Time datetime	`update_time`	Date and time when the lead was last updated.
Visible To text	`visible_to`	Visibility setting of the lead.
CC Email text	`cc_email`	BCC/CC email dropbox address for the lead.

Name	API name	Description
ID int	`id`	Unique identifier of the team.
Name text	`name`	Name of the team.
Description text	`description`	Description of the team.
Manager ID int	`manager_id`	ID of the user who manages the team.
Active Members Count int	`active_members_count`	Number of active members in the team.
Add Time datetime	`add_time`	Date and time when the team was created.
Created By User ID int	`created_by_user_id`	ID of the user who created the team.
Users structure	`users`	List of user IDs that are members of the team.

Name	API name	Description
ID int	`id`	Unique identifier of the mail message thread.
Parties structure	`parties`	Object containing to/from/cc/bcc mail parties.
Folders json	`folders`	List of folder labels for the message thread.
Account ID text	`account_id`	ID of the connected email account.
User ID int	`user_id`	ID of the Pipedrive user owning this mailbox thread.
Version int	`version`	Version number of the message thread.
Subject text	`subject`	Subject line of the email thread.
Subject Draft text	`subject_draft`	Draft subject line.
Snippet text	`snippet`	Preview snippet of the email content.
Summary text	`summary`	AI-generated summary of the email thread.
Snippet Draft text	`snippet_draft`	Preview snippet of the draft.
Snippet Sent text	`snippet_sent`	Preview snippet of the sent message.
Message Count int	`message_count`	Total number of messages in the thread.
Read Flag int	`read_flag`	Whether the thread has been read.
Label IDs json	`label_ids`	List of label IDs assigned to the thread.
Mail Tracking Status text	`mail_tracking_status`	Status of mail tracking for the thread.
Has Attachments Flag int	`has_attachments_flag`	Whether the thread has attachments.
Has Inline Attachments Flag int	`has_inline_attachments_flag`	Whether the thread has inline attachments.
Has Real Attachments Flag int	`has_real_attachments_flag`	Whether the thread has real (non-inline) attachments.
Has Draft Flag int	`has_draft_flag`	Whether the thread has a draft.
Has Sent Flag int	`has_sent_flag`	Whether the thread has sent messages.
Archived Flag bool	`archived_flag`	Whether the thread is archived.
External Archived Flag bool	`external_archived_flag`	Whether the thread is archived externally.
Deleted Flag int	`deleted_flag`	Whether the thread is deleted.
Shared Flag int	`shared_flag`	Whether the thread is shared.
Synced Flag int	`synced_flag`	Whether the thread is synced.
External Deleted Flag int	`external_deleted_flag`	Whether the thread is deleted externally.
Smart BCC Flag int	`smart_bcc_flag`	Whether smart BCC is enabled for the thread.
First Message To Me Flag int	`first_message_to_me_flag`	Whether the first message was addressed to the current user.
Mail Link Tracking Enabled Flag int	`mail_link_tracking_enabled_flag`	Whether link tracking is enabled for the thread.
Last Message Timestamp datetime	`last_message_timestamp`	Timestamp of the last message in the thread.
First Message Timestamp datetime	`first_message_timestamp`	Timestamp of the first message in the thread.
Last Message Sent Timestamp datetime	`last_message_sent_timestamp`	Timestamp of the last sent message.
Last Message Received Timestamp datetime	`last_message_received_timestamp`	Timestamp of the last received message.
Last Draft Update Timestamp datetime	`last_draft_update_timestamp`	Timestamp of the last draft update.
Add Time datetime	`add_time`	Date and time when the thread was added to Pipedrive.
Update Time datetime	`update_time`	Date and time when the thread was last updated.
Deal ID int	`deal_id`	ID of the deal linked to the thread.
Deal Status text	`deal_status`	Status of the linked deal.
Lead ID text	`lead_id`	ID of the lead linked to the thread.
Project ID int	`project_id`	ID of the project linked to the thread.
All Messages Sent Flag int	`all_messages_sent_flag`	Whether all messages in the thread are sent.
Has Message In Queue int	`has_message_in_queue`	Whether there is a message queued for sending.
Connection Type text	`connection_type`	Type of email connection (e.g. private, shared).
Assigned User IDs json	`assigned_user_ids`	List of user IDs assigned to the thread.

Name	API name	Description
ID int	`id`	Unique identifier of the note.
User ID int	`user_id`	ID of the user who created the note.
Deal ID int	`deal_id`	ID of the deal linked to the note.
Person ID int	`person_id`	ID of the person linked to the note.
Org ID int	`org_id`	ID of the organization linked to the note.
Lead ID text	`lead_id`	ID of the lead linked to the note.
Project ID int	`project_id`	ID of the project linked to the note.
Content text	`content`	HTML content of the note.
Add Time datetime	`add_time`	Date and time when the note was created.
Update Time datetime	`update_time`	Date and time when the note was last updated.
Active Flag bool	`active_flag`	Whether the note is active.
Pinned To Deal Flag bool	`pinned_to_deal_flag`	Whether the note is pinned to its linked deal.
Pinned To Person Flag bool	`pinned_to_person_flag`	Whether the note is pinned to its linked person.
Pinned To Organization Flag bool	`pinned_to_organization_flag`	Whether the note is pinned to its linked organization.
Pinned To Lead Flag bool	`pinned_to_lead_flag`	Whether the note is pinned to its linked lead.
Last Update User ID int	`last_update_user_id`	ID of the user who last updated the note.

Name	API name	Description
ID int	`id`	Unique identifier of the field definition.
Key text	`key`	API key for the field. Custom fields have a 40-character hex key; system fields use readable names.
Name text	`name`	Human-readable name of the field.
Field Type text	`field_type`	Data type of the field (e.g. varchar, int, date, enum).
Add Time datetime	`add_time`	Date and time when the field was created.
Update Time datetime	`update_time`	Date and time when the field was last updated.
Edit Flag bool	`edit_flag`	Whether the field value can be edited.
Add Visible Flag bool	`add_visible_flag`	Whether the field is visible in the add item form.
Active Flag bool	`active_flag`	Whether the field is active.
Filtering Allowed bool	`filtering_allowed`	Whether filtering by this field is allowed.
Sortable Flag bool	`sortable_flag`	Whether the list can be sorted by this field.
Mandatory Flag bool	`mandatory_flag`	Whether this field is mandatory when creating an organization.
Searchable Flag bool	`searchable_flag`	Whether this field is included in search.
Bulk Edit Allowed bool	`bulk_edit_allowed`	Whether this field can be edited in bulk.
JSON Column Flag bool	`json_column_flag`	Whether this field is stored as a JSON column.
Show In Pipelines json	`show_in_pipelines`	Pipeline visibility settings for this field.

Name	API name	Description
ID int	`id`	Unique identifier of the organization.
Owner ID int	`owner_id_value`	ID of the user who owns the organization (extracted from owner_id.value).
Owner Name (from object) text	`owner_id_name`	Name of the user who owns the organization.
Owner Email text	`owner_id_email`	Email of the user who owns the organization.
Name text	`name`	Name of the organization.
Open Deals Count int	`open_deals_count`	Number of open deals for the organization.
Related Open Deals Count int	`related_open_deals_count`	Number of related open deals.
Closed Deals Count int	`closed_deals_count`	Number of closed deals.
Related Closed Deals Count int	`related_closed_deals_count`	Number of related closed deals.
Email Messages Count int	`email_messages_count`	Number of email messages linked to the organization.
People Count int	`people_count`	Number of persons linked to the organization.
Activities Count int	`activities_count`	Total number of activities for the organization.
Done Activities Count int	`done_activities_count`	Number of completed activities.
Undone Activities Count int	`undone_activities_count`	Number of pending activities.
Files Count int	`files_count`	Number of files attached to the organization.
Notes Count int	`notes_count`	Number of notes on the organization.
Followers Count int	`followers_count`	Number of followers of the organization.
Won Deals Count int	`won_deals_count`	Number of won deals.
Related Won Deals Count int	`related_won_deals_count`	Number of related won deals.
Lost Deals Count int	`lost_deals_count`	Number of lost deals.
Related Lost Deals Count int	`related_lost_deals_count`	Number of related lost deals.
Active Flag bool	`active_flag`	Whether the organization is active.
Picture ID int	`picture_id`	ID of the organization's picture.
Country Code text	`country_code`	Country code of the organization.
First Char text	`first_char`	First character of the organization name (for indexing).
Update Time datetime	`update_time`	Date and time when the organization was last updated.
Delete Time datetime	`delete_time`	Date and time when the organization was deleted.
Add Time datetime	`add_time`	Date and time when the organization was created.
Visible To text	`visible_to`	Visibility setting of the organization.
Next Activity Date date	`next_activity_date`	Date of the next scheduled activity.
Next Activity Time text	`next_activity_time`	Time of the next scheduled activity.
Next Activity ID int	`next_activity_id`	ID of the next scheduled activity.
Last Activity ID int	`last_activity_id`	ID of the last completed activity.
Last Activity Date date	`last_activity_date`	Date of the last completed activity.
Label text	`label`	Label ID assigned to the organization.
Label IDs json	`label_ids`	List of label IDs assigned to the organization.
Address text	`address`	Full address of the organization.
Address Subpremise text	`address_subpremise`	Subpremise part of the address.
Address Street Number text	`address_street_number`	Street number of the address.
Address Route text	`address_route`	Route/street name of the address.
Address Sublocality text	`address_sublocality`	Sublocality of the address.
Address Locality text	`address_locality`	Locality/city of the address.
Address Admin Area Level 1 text	`address_admin_area_level_1`	Administrative area level 1 (state/province).
Address Admin Area Level 2 text	`address_admin_area_level_2`	Administrative area level 2 (county).
Address Country text	`address_country`	Country of the address.
Address Country Code text	`address_country_code`	Country code of the address.
Address Postal Code text	`address_postal_code`	Postal code of the address.
Address Formatted Address text	`address_formatted_address`	Full formatted address string.
Website text	`website`	Website URL of the organization.
LinkedIn text	`linkedin`	LinkedIn profile URL of the organization.
Industry text	`industry`	Industry of the organization.
Annual Revenue decimal	`annual_revenue`	Annual revenue of the organization.
Employee Count int	`employee_count`	Number of employees in the organization.
Owner Name text	`owner_name`	Name of the organization owner (denormalized).
CC Email text	`cc_email`	BCC/CC email dropbox address for the organization.
Company ID int	`company_id`	ID of the Pipedrive company account.

Name	API name	Description
ID text	`id`	Unique identifier of the permission set (UUID).
Name text	`name`	Name of the permission set.
Assignment Count int	`assignment_count`	Number of users assigned to this permission set.
App text	`app`	Application the permission set applies to (e.g. sales, projects).
Type text	`type`	Type of permission set (admin or regular).

Name	API name	Description
ID int	`id`	Unique identifier of the field definition.
Key text	`key`	API key for the field. Custom fields have a 40-character hex key; system fields use readable names.
Name text	`name`	Human-readable name of the field.
Field Type text	`field_type`	Data type of the field (e.g. varchar, int, date, enum).
Add Time datetime	`add_time`	Date and time when the field was created.
Update Time datetime	`update_time`	Date and time when the field was last updated.
Edit Flag bool	`edit_flag`	Whether the field value can be edited.
Add Visible Flag bool	`add_visible_flag`	Whether the field is visible in the add item form.
Active Flag bool	`active_flag`	Whether the field is active.
Filtering Allowed bool	`filtering_allowed`	Whether filtering by this field is allowed.
Sortable Flag bool	`sortable_flag`	Whether the list can be sorted by this field.
Mandatory Flag bool	`mandatory_flag`	Whether this field is mandatory when creating a person.
Searchable Flag bool	`searchable_flag`	Whether this field is included in search.
Bulk Edit Allowed bool	`bulk_edit_allowed`	Whether this field can be edited in bulk.
JSON Column Flag bool	`json_column_flag`	Whether this field is stored as a JSON column.
Show In Pipelines json	`show_in_pipelines`	Pipeline visibility settings for this field.

Name	API name	Description
ID int	`id`	Unique identifier of the person.
Owner ID int	`owner_id_value`	ID of the user who owns the person record (extracted from owner_id.value).
Owner Name (from object) text	`owner_id_name`	Name of the user who owns the person record.
Owner Email text	`owner_id_email`	Email of the user who owns the person record.
Org ID int	`org_id`	ID of the organization linked to the person.
Name text	`name`	Full name of the person.
First Name text	`first_name`	First name of the person.
Last Name text	`last_name`	Last name of the person.
Open Deals Count int	`open_deals_count`	Number of open deals for the person.
Related Open Deals Count int	`related_open_deals_count`	Number of related open deals.
Closed Deals Count int	`closed_deals_count`	Number of closed deals.
Related Closed Deals Count int	`related_closed_deals_count`	Number of related closed deals.
Participant Open Deals Count int	`participant_open_deals_count`	Number of open deals where the person is a participant.
Participant Closed Deals Count int	`participant_closed_deals_count`	Number of closed deals where the person is a participant.
Email Messages Count int	`email_messages_count`	Number of email messages linked to the person.
Activities Count int	`activities_count`	Total number of activities for the person.
Done Activities Count int	`done_activities_count`	Number of completed activities.
Undone Activities Count int	`undone_activities_count`	Number of pending activities.
Files Count int	`files_count`	Number of files attached to the person.
Notes Count int	`notes_count`	Number of notes on the person.
Followers Count int	`followers_count`	Number of followers of the person.
Won Deals Count int	`won_deals_count`	Number of won deals.
Related Won Deals Count int	`related_won_deals_count`	Number of related won deals.
Lost Deals Count int	`lost_deals_count`	Number of lost deals.
Related Lost Deals Count int	`related_lost_deals_count`	Number of related lost deals.
Active Flag bool	`active_flag`	Whether the person is active.
Phone structure	`phone`	List of phone numbers for the person.
Email structure	`email`	List of email addresses for the person.
IM structure	`im`	List of instant messaging handles for the person.
First Char text	`first_char`	First character of the person's name (for indexing).
Update Time datetime	`update_time`	Date and time when the person was last updated.
Delete Time datetime	`delete_time`	Date and time when the person was deleted.
Add Time datetime	`add_time`	Date and time when the person was created.
Visible To text	`visible_to`	Visibility setting of the person.
Picture ID int	`picture_id`	ID of the person's profile picture.
Next Activity Date date	`next_activity_date`	Date of the next scheduled activity.
Next Activity Time text	`next_activity_time`	Time of the next scheduled activity.
Next Activity ID int	`next_activity_id`	ID of the next scheduled activity.
Last Activity ID int	`last_activity_id`	ID of the last completed activity.
Last Activity Date date	`last_activity_date`	Date of the last completed activity.
Last Incoming Mail Time datetime	`last_incoming_mail_time`	Date and time of the last received email.
Last Outgoing Mail Time datetime	`last_outgoing_mail_time`	Date and time of the last sent email.
Label text	`label`	Label ID assigned to the person.
Label IDs json	`label_ids`	List of label IDs assigned to the person.
Postal Address text	`postal_address`	Full postal address of the person.
Postal Address Lat decimal	`postal_address_lat`	Latitude of the postal address.
Postal Address Long decimal	`postal_address_long`	Longitude of the postal address.
Postal Address Subpremise text	`postal_address_subpremise`	Subpremise of the postal address.
Postal Address Street Number text	`postal_address_street_number`	Street number of the postal address.
Postal Address Route text	`postal_address_route`	Route/street of the postal address.
Postal Address Sublocality text	`postal_address_sublocality`	Sublocality of the postal address.
Postal Address Locality text	`postal_address_locality`	Locality/city of the postal address.
Postal Address Admin Area Level 1 text	`postal_address_admin_area_level_1`	Administrative area level 1 of postal address.
Postal Address Admin Area Level 2 text	`postal_address_admin_area_level_2`	Administrative area level 2 of postal address.
Postal Address Country text	`postal_address_country`	Country of the postal address.
Postal Address Postal Code text	`postal_address_postal_code`	Postal code of the postal address.
Postal Address Formatted Address text	`postal_address_formatted_address`	Full formatted postal address string.
Notes text	`notes`	Notes about the person.
Birthday date	`birthday`	Birthday of the person.
Job Title text	`job_title`	Job title of the person.
Org Name text	`org_name`	Name of the linked organization (denormalized).
Owner Name text	`owner_name`	Name of the owner (denormalized).
Primary Email text	`primary_email`	Primary email address of the person.
CC Email text	`cc_email`	BCC/CC email dropbox address for the person.
Company ID int	`company_id`	ID of the Pipedrive company account.
Custom Fields json	`custom_fields`	Custom field values keyed by 40-character hex field key.

Name	API name	Description
ID int	`id`	Unique identifier of the pipeline.
Name text	`name`	Name of the pipeline.
URL Title text	`url_title`	URL-friendly title of the pipeline.
Order Nr int	`order_nr`	Order number for sorting pipelines.
Active bool	`active`	Whether the pipeline is active.
Deal Probability bool	`deal_probability`	Whether deal probability is enabled for this pipeline.
Add Time datetime	`add_time`	Date and time when the pipeline was created.
Update Time datetime	`update_time`	Date and time when the pipeline was last updated.
Selected bool	`selected`	Whether the pipeline is currently selected/default.

Name	API name	Description
ID int	`id`	Unique identifier of the field definition.
Key text	`key`	API key for the field. Custom fields have a 40-character hex key; system fields use readable names.
Name text	`name`	Human-readable name of the field.
Field Type text	`field_type`	Data type of the field (e.g. varchar, int, date, enum).
Add Time datetime	`add_time`	Date and time when the field was created.
Update Time datetime	`update_time`	Date and time when the field was last updated.
Edit Flag bool	`edit_flag`	Whether the field value can be edited.
Add Visible Flag bool	`add_visible_flag`	Whether the field is visible in the add item form.
Active Flag bool	`active_flag`	Whether the field is active.
Filtering Allowed bool	`filtering_allowed`	Whether filtering by this field is allowed.
Sortable Flag bool	`sortable_flag`	Whether the list can be sorted by this field.
Mandatory Flag bool	`mandatory_flag`	Whether this field is mandatory when creating a product.
Searchable Flag bool	`searchable_flag`	Whether this field is included in search.
Bulk Edit Allowed bool	`bulk_edit_allowed`	Whether this field can be edited in bulk.
JSON Column Flag bool	`json_column_flag`	Whether this field is stored as a JSON column.
Show In Pipelines json	`show_in_pipelines`	Pipeline visibility settings for this field.

Name	API name	Description
ID int	`id`	Unique identifier of the product.
Name text	`name`	Name of the product.
Code text	`code`	Product code or SKU.
Description text	`description`	Description of the product.
Unit text	`unit`	Unit of measurement for the product.
Tax decimal	`tax`	Tax rate applied to the product (percentage).
Category text	`category`	Category of the product.
Active Flag bool	`active_flag`	Whether the product is active.
Selectable bool	`selectable`	Whether the product can be added to deals.
Visible To text	`visible_to`	Visibility setting of the product.
Owner ID int	`owner_id_value`	ID of the user who owns the product (extracted from owner_id.value).
Owner Name text	`owner_id_name`	Name of the user who owns the product.
Files Count int	`files_count`	Number of files attached to the product.
First Char text	`first_char`	First character of the product name (for indexing).
Billing Frequency text	`billing_frequency`	Billing frequency of the product (e.g. weekly, monthly).
Billing Frequency Cycles int	`billing_frequency_cycles`	Number of billing frequency cycles.
Add Time datetime	`add_time`	Date and time when the product was created.
Update Time datetime	`update_time`	Date and time when the product was last updated.
Product Variations json	`product_variations`	Product variation data (structure depends on account configuration).
Prices structure	`prices`	List of price entries for the product.

Name	API name	Description
ID int	`id`	Unique identifier of the role.
Parent Role ID int	`parent_role_id`	ID of the parent role in the hierarchy.
Name text	`name`	Name of the role.
Active Flag bool	`active_flag`	Whether the role is active.
Assignment Count text	`assignment_count`	Number of users assigned to this role.
Sub Role Count text	`sub_role_count`	Number of sub-roles under this role.
Level int	`level`	Depth level of the role in the hierarchy.
Description text	`description`	Description of the role and its purpose.

Name	API name	Description
ID int	`id`	Unique identifier of the pipeline stage.
Order Nr int	`order_nr`	Order number of the stage within the pipeline.
Name text	`name`	Name of the pipeline stage.
Active Flag bool	`active_flag`	Whether the stage is active.
Deal Probability int	`deal_probability`	Default deal probability percentage for this stage.
Pipeline ID int	`pipeline_id`	ID of the pipeline this stage belongs to.
Rotten Flag bool	`rotten_flag`	Whether the rotten deal feature is enabled for this stage.
Rotten Days int	`rotten_days`	Number of days before a deal becomes rotten in this stage.
Add Time datetime	`add_time`	Date and time when the stage was created.
Update Time datetime	`update_time`	Date and time when the stage was last updated.
Pipeline Name text	`pipeline_name`	Name of the parent pipeline (denormalized).
Pipeline Deal Probability bool	`pipeline_deal_probability`	Whether deal probability is enabled at the pipeline level.

Name	API name	Description
Add Followers When Importing bool	`add_followers_when_importing`	Whether to add followers when importing data.
Advanced Permissions int	`advanced_permissions`	Advanced permissions setting.
Auto Create New Persons From Forwarder Emails bool	`auto_create_new_persons_from_forwarder_emails`	Whether to automatically create persons from forwarded emails.
Autofill Deal Expected Close Date bool	`autofill_deal_expected_close_date`	Whether to autofill the expected close date for deals.
Automation Live int	`automation_live`	Automation live setting.
Beta App bool	`beta_app`	Whether the beta app is enabled.
Beta Tester bool	`beta_tester`	Whether the user is a beta tester.
Billing Managed By Sales bool	`billing_managed_by_sales`	Whether billing is managed by sales.
Callto Link Syntax text	`callto_link_syntax`	Syntax format for callto links.
Daily DOI Limit int	`daily_doi_limit`	Daily double opt-in limit.
Data Police int	`data_police`	Data police setting.
Enforce 2FA bool	`enforce_2fa`	Whether two-factor authentication is enforced.
Enforce DOI bool	`enforce_doi`	Whether double opt-in is enforced.
Enforce SSO bool	`enforce_sso`	Whether single sign-on is enforced.
File Upload Destination text	`file_upload_destination`	Destination for file uploads (e.g. s3).
List Limit int	`list_limit`	Maximum number of items per list page.
Flow Limit int	`flow_limit`	Maximum number of automation flows.
Max Deal Age In Average Progress Calculation int	`max_deal_age_in_average_progress_calculation`	Maximum deal age in days for average progress calculation.
Notes Per Deal int	`notes_per_deal`	Maximum number of notes per deal.
Nylas Sync int	`nylas_sync`	Nylas email sync setting.
Onboarding Complete bool	`onboarding_complete`	Whether onboarding has been completed.
Person Duplicate Condition text	`person_duplicate_condition`	Condition expression for detecting duplicate persons.
Organization Duplicate Condition text	`organization_duplicate_condition`	Condition expression for detecting duplicate organizations.
Products bool	`products`	Whether the products feature is enabled.
Search Backend text	`search_backend`	Search backend engine used.
SSO Login Enabled bool	`sso_login_enabled`	Whether SSO login is enabled.
Teams int	`teams`	Teams feature setting.
Whitelisted IPs bool	`whitelisted_ips`	Whether IP whitelisting is enabled.
Default Currency text	`default_currency`	Default currency code for the account.
Send Email Notifications text	`send_email_notifications`	Frequency of email notification sending.
Selected Tax System text	`selected_tax_system`	Tax system selected (e.g. inclusive, exclusive).
Activity Email Reminders bool	`activity_email_reminders`	Whether activity email reminders are enabled.
Activity Email Reminders Send Type text	`activity_email_reminders_send_type`	When to send activity email reminders.
Activity Email Reminders Amount Before int	`activity_email_reminders_amount_before`	Amount of time before the activity to send reminder.
File Convert Allowed bool	`file_convert_allowed`	Whether file conversion is allowed.
Deals Timeline Default Field text	`deals_timeline_default_field`	Default field used in deals timeline view.
Deals Timeline Interval text	`deals_timeline_interval`	Interval for the deals timeline (e.g. month).
Deals Timeline Column Count int	`deals_timeline_column_count`	Number of columns in deals timeline.
Share Incoming Emails bool	`share_incoming_emails`	Whether incoming emails are shared.
Connect Threads With Deals bool	`connect_threads_with_deals`	Whether email threads are connected with deals.
Email Sync Filter text	`email_sync_filter`	Email sync filter setting.
Calendar Sync Activity Type text	`calendar_sync_activity_type`	Activity type used for calendar sync.
Calendar Sync Subject Format text	`calendar_sync_subject_format`	Format for calendar sync event subjects.
Link Person To Org bool	`link_person_to_org`	Whether persons are automatically linked to organizations.
Timezone Automatic Update bool	`timezone_automatic_update`	Whether timezone is automatically updated.
Use Pipedrive Mailto Links bool	`use_pipedrive_mailto_links`	Whether to use Pipedrive mailto links.
Marketplace Allow Only Admin Installs bool	`marketplace_allow_only_admin_installs`	Whether only admins can install marketplace apps.
Marketplace Notify Admin If App Installed bool	`marketplace_notify_admin_if_app_installed`	Whether admins are notified when an app is installed.
Security Alerts Thresholds json	`security_alerts_thresholds`	Security alert threshold settings per entity type.
Fiscal Year json	`fiscal_year`	Fiscal year configuration.
Maintenance Period json	`maintenance_period`	Maintenance period configuration.
Default Add Activity After Deal Won json	`default_add_activity_after_deal_won`	Configuration for adding activity after a deal is won.
Superdata Panel State json	`superdata_panel_state`	State of the superdata side panels.
Sales Assistant Email Tracking json	`sales_assistant_email_tracking`	Sales assistant email tracking notification settings.
Sales Assistant Activity Reminders json	`sales_assistant_activity_reminders`	Sales assistant activity reminder notification settings.
Sales Assistant Sales Advice json	`sales_assistant_sales_advice`	Sales assistant sales advice notification settings.
Sales Assistant Product Updates json	`sales_assistant_product_updates`	Sales assistant product update notification settings.
Deal Block Order json	`deal_block_order`	Order and visibility of blocks in deal detail view.
Person Block Order json	`person_block_order`	Order and visibility of blocks in person detail view.
Organization Block Order json	`organization_block_order`	Order and visibility of blocks in organization detail view.
Current Pipeline ID int	`current_pipeline_id`	ID of the currently selected pipeline.
Show Deal Won Animation bool	`show_deal_won_animation`	Whether to show animation when a deal is won.
Add Activity After Deal Won bool	`add_activity_after_deal_won`	Whether to add an activity when a deal is won.
Filter Show Inactive Users bool	`filter_show_inactive_users`	Whether to show inactive users in filters.

Name	API name	Description
ID int	`id`	Unique identifier of the user.
Name text	`name`	Full name of the user.
Email text	`email`	Email address of the user.
Lang int	`lang`	Language ID of the user.
Locale text	`locale`	Locale setting of the user (e.g. pl_PL).
Timezone Name text	`timezone_name`	Timezone name of the user (e.g. Europe/Warsaw).
Timezone Offset text	`timezone_offset`	UTC offset of the user's timezone.
Default Currency text	`default_currency`	Default currency code for the user.
Icon URL text	`icon_url`	URL of the user's profile icon.
Active Flag bool	`active_flag`	Whether the user account is active.
Is Deleted bool	`is_deleted`	Whether the user account has been deleted.
Is Admin int	`is_admin`	Whether the user has admin privileges.
Role ID int	`role_id`	ID of the role assigned to the user.
Created datetime	`created`	Date and time when the user account was created.
Has Created Company bool	`has_created_company`	Whether the user has created a company.
Is You bool	`is_you`	Whether this user is the authenticated user making the API call.
Access structure	`access`	List of access permissions per application for the user.
Phone text	`phone`	Phone number of the user.
Modified datetime	`modified`	Date and time when the user record was last modified.
Last Login datetime	`last_login`	Date and time of the user's last login.

Under each field name is the column it becomes in the destination table. Select All checks everything at once.

The set of available fields depends on the report type. Renta partitions the destination table by Update Time.

Renta flattens the nested objects that Pipedrive returns. The owner, person, and organization of a record arrive as separate columns for the identifier, the name, and the email. An organization address and an activity location arrive twice: as the full string and as separate components such as street, locality, and country.

Fields that hold a list of values load as nested records.

Report type	Fields that load as nested records
Activities	Participants
Legacy Teams	Users
Mailbox	Parties
Persons	Phone, Email, IM
Products	Prices
Users	Access

Fields whose shape depends on the record itself arrive as JSON. These are Custom Fields in the Deals and Persons reports, Label IDs, Attendees and Series in Activities, Expected Outcome and Report in Goals, and the preference objects of User Settings.

Inside Custom Fields, every value is keyed by the Pipedrive field key rather than by the field name. The Deal Fields, Person Fields, Organization Fields, and Product Fields report types carry both the Key and the Name, so load one of them to resolve the keys into names.

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

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 Pipedrive integration in the Completed status

Sync strategy

Renta synchronizes every Pipedrive report type the same way.

Strategy	Supported report types	Description
Full reload	Activities, Activity Types, Call Logs, Currencies, Deal Fields, Deals, Files, Filters, Goals, Lead Sources, Leads, Legacy Teams, Mailbox, Notes, Organization Fields, Organizations, Permission Sets, Person Fields, Persons, Pipelines, Product Fields, Products, Roles, Stages, User Settings, Users	Renta reads the object in full on every run and replaces the contents of the destination table. The table mirrors the Pipedrive account at the time of the run, and a record that Pipedrive stops returning leaves the table on the next run.

Selecting the Update Time parameter partitions the destination table by the day the record was last changed. Currencies, Goals, Lead Sources, Legacy Teams, Permission Sets, Roles, User Settings, and Users have no update-time field, so their tables stay unpartitioned.

Because every run reads the object in full, the pipeline has no date range or overwrite period settings. Pipedrive counts every request against the daily API budget of your account, so frequent runs on large objects can exhaust that budget.

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.