Pipedrive

Use Pipedrive to manage deals, leads, activities, and projects, inspect pipelines, and retrieve CRM files and mail threads.

Usage Instructions

Integrate Pipedrive into your workflow. Manage deals, leads, persons, organizations, notes, projects, activities, files, and mail, and start workflows from Pipedrive webhooks when records change.

Actions

Get All Deals from Pipedrive

Retrieve all deals from Pipedrive with optional filters

Input

Parameter	Type	Required	Description
`status`	string	No	Only fetch deals with a specific status. Values: open, won, lost. If omitted, all not deleted deals are returned
`person_id`	string	No	If supplied, only deals linked to the specified person are returned (e.g., "456")
`org_id`	string	No	If supplied, only deals linked to the specified organization are returned (e.g., "789")
`pipeline_id`	string	No	If supplied, only deals in the specified pipeline are returned (e.g., "1")
`updated_since`	string	No	If set, only deals updated after this time are returned. Format: 2025-01-01T10:20:00Z
`limit`	string	No	Number of results to return (e.g., "50", default: 100, max: 500)
`cursor`	string	No	For pagination, the marker representing the first item on the next page

Output

Parameter	Type	Description
`deals`	array	Array of deal objects from Pipedrive
↳ `id`	number	Deal ID
↳ `title`	string	Deal title
↳ `value`	number	Deal value
↳ `currency`	string	Currency code
↳ `status`	string	Deal status (open, won, lost, deleted)
↳ `stage_id`	number	Pipeline stage ID
↳ `pipeline_id`	number	Pipeline ID
↳ `person_id`	number	Associated person ID
↳ `org_id`	number	Associated organization ID
↳ `owner_id`	number	Deal owner user ID
↳ `add_time`	string	When the deal was created (ISO 8601)
↳ `update_time`	string	When the deal was last updated (ISO 8601)
↳ `won_time`	string	When the deal was won
↳ `lost_time`	string	When the deal was lost
↳ `close_time`	string	When the deal was closed
↳ `expected_close_date`	string	Expected close date
`metadata`	object	Pagination metadata for the response
↳ `total_items`	number	Total number of items
↳ `has_more`	boolean	Whether more items are available
↳ `next_cursor`	string	Cursor for fetching the next page (v2 endpoints)
↳ `next_start`	number	Offset for fetching the next page (v1 endpoints)
`success`	boolean	Operation success status

Get Deal Details from Pipedrive

Retrieve detailed information about a specific deal

Input

Parameter	Type	Required	Description
`deal_id`	string	Yes	The ID of the deal to retrieve (e.g., "123")

Output

Parameter	Type	Description
`deal`	object	Deal object with full details
`success`	boolean	Operation success status

Create Deal in Pipedrive

Create a new deal in Pipedrive

Input

Parameter	Type	Required	Description
`title`	string	Yes	The title of the deal (e.g., "Enterprise Software License")
`value`	string	No	The monetary value of the deal (e.g., "5000")
`currency`	string	No	Currency code (e.g., "USD", "EUR", "GBP")
`person_id`	string	No	ID of the person this deal is associated with (e.g., "456")
`org_id`	string	No	ID of the organization this deal is associated with (e.g., "789")
`pipeline_id`	string	No	ID of the pipeline this deal should be placed in (e.g., "1")
`stage_id`	string	No	ID of the stage this deal should be placed in (e.g., "2")
`status`	string	No	Status of the deal: open, won, lost
`expected_close_date`	string	No	Expected close date in YYYY-MM-DD format (e.g., "2025-06-30")

Output

Parameter	Type	Description
`deal`	object	The created deal object
`success`	boolean	Operation success status

Update Deal in Pipedrive

Update an existing deal in Pipedrive

Input

Parameter	Type	Required	Description
`deal_id`	string	Yes	The ID of the deal to update (e.g., "123")
`title`	string	No	New title for the deal (e.g., "Updated Enterprise License")
`value`	string	No	New monetary value for the deal (e.g., "7500")
`status`	string	No	New status: open, won, lost
`stage_id`	string	No	New stage ID for the deal (e.g., "3")
`expected_close_date`	string	No	New expected close date in YYYY-MM-DD format (e.g., "2025-07-15")

Output

Parameter	Type	Description
`deal`	object	The updated deal object
`success`	boolean	Operation success status

Get Files from Pipedrive

Retrieve files from Pipedrive with optional filters

Input

Parameter	Type	Required	Description
`sort`	string	No	Sort files by field (supported: "id", "update_time")
`limit`	string	No	Number of results to return (e.g., "50", default: 100, max: 100)
`start`	string	No	Pagination start offset (0-based index of the first item to return)
`downloadFiles`	boolean	No	Download file contents into file outputs

Output

Parameter	Type	Description
`files`	array	Array of file objects from Pipedrive
↳ `id`	number	File ID
↳ `name`	string	File name
↳ `file_type`	string	File type/extension
↳ `file_size`	number	File size in bytes
↳ `add_time`	string	When the file was uploaded
↳ `update_time`	string	When the file was last updated
↳ `deal_id`	number	Associated deal ID
↳ `person_id`	number	Associated person ID
↳ `org_id`	number	Associated organization ID
↳ `url`	string	File download URL
`downloadedFiles`	file[]	Downloaded files from Pipedrive
`total_items`	number	Total number of files returned
`has_more`	boolean	Whether more files are available
`next_start`	number	Offset for fetching the next page
`success`	boolean	Operation success status

Get Mail Threads from Pipedrive

Retrieve mail threads from Pipedrive mailbox

Input

Parameter	Type	Required	Description
`folder`	string	No	Filter by folder: inbox, drafts, sent, archive (default: inbox)
`limit`	string	No	Number of results to return (e.g., "25", default: 50)
`start`	string	No	Pagination start offset (0-based index of the first item to return)

Output

Parameter	Type	Description
`messages`	array	Array of mail thread objects from Pipedrive mailbox
`total_items`	number	Total number of mail threads returned
`has_more`	boolean	Whether more messages are available
`next_start`	number	Offset for fetching the next page
`success`	boolean	Operation success status

Get Mail Thread Messages from Pipedrive

Retrieve all messages from a specific mail thread

Input

Parameter	Type	Required	Description
`thread_id`	string	Yes	The ID of the mail thread (e.g., "12345")

Output

Parameter	Type	Description
`messages`	array	Array of mail message objects from the thread
`metadata`	object	Thread and pagination metadata
`success`	boolean	Operation success status

Get Pipelines from Pipedrive

Retrieve all pipelines from Pipedrive

Input

Parameter	Type	Required	Description
`sort_by`	string	No	Field to sort by: id, update_time, add_time (default: id)
`sort_direction`	string	No	Sorting direction: asc, desc (default: asc)
`limit`	string	No	Number of results to return (e.g., "50", default: 100, max: 500)
`start`	string	No	Pagination start offset (0-based index of the first item to return)

Output

Parameter	Type	Description
`pipelines`	array	Array of pipeline objects from Pipedrive
↳ `id`	number	Pipeline ID
↳ `name`	string	Pipeline name
↳ `url_title`	string	URL-friendly title
↳ `order_nr`	number	Pipeline order number
↳ `active`	boolean	Whether the pipeline is active
↳ `deal_probability`	boolean	Whether deal probability is enabled
↳ `add_time`	string	When the pipeline was created
↳ `update_time`	string	When the pipeline was last updated
`total_items`	number	Total number of pipelines returned
`has_more`	boolean	Whether more pipelines are available
`next_start`	number	Offset for fetching the next page
`success`	boolean	Operation success status

Get Pipeline Deals from Pipedrive

Retrieve all deals in a specific pipeline

Input

Parameter	Type	Required	Description
`pipeline_id`	string	Yes	The ID of the pipeline (e.g., "1")
`stage_id`	string	No	Filter by specific stage within the pipeline (e.g., "2")
`limit`	string	No	Number of results to return (e.g., "50", default: 100, max: 500)
`start`	string	No	Pagination start offset (0-based index of the first item to return)

Output

Parameter	Type	Description
`deals`	array	Array of deal objects from the pipeline
`metadata`	object	Pipeline and pagination metadata
`success`	boolean	Operation success status

Get Projects from Pipedrive

Retrieve all projects or a specific project from Pipedrive

Input

Parameter	Type	Required	Description
`project_id`	string	No	Optional: ID of a specific project to retrieve (e.g., "123")
`status`	string	No	Filter by project status: open, completed, deleted (only for listing all)
`limit`	string	No	Number of results to return (e.g., "50", default: 100, max: 500, only for listing all)
`cursor`	string	No	For pagination, the marker representing the first item on the next page

Output

Parameter	Type	Description
`projects`	array	Array of project objects (when listing all)
`project`	object	Single project object (when project_id is provided)
`total_items`	number	Total number of projects returned
`has_more`	boolean	Whether more projects are available
`next_cursor`	string	Cursor for fetching the next page
`success`	boolean	Operation success status

Create Project in Pipedrive

Create a new project in Pipedrive

Input

Parameter	Type	Required	Description
`title`	string	Yes	The title of the project (e.g., "Q2 Marketing Campaign")
`description`	string	No	Description of the project
`start_date`	string	No	Project start date in YYYY-MM-DD format (e.g., "2025-04-01")
`end_date`	string	No	Project end date in YYYY-MM-DD format (e.g., "2025-06-30")

Output

Parameter	Type	Description
`project`	object	The created project object
`success`	boolean	Operation success status

Get Activities from Pipedrive

Retrieve activities (tasks) from Pipedrive with optional filters

Input

Parameter	Type	Required	Description
`user_id`	string	No	Filter activities by user ID (e.g., "123")
`type`	string	No	Filter by activity type (call, meeting, task, deadline, email, lunch)
`done`	string	No	Filter by completion status: 0 for not done, 1 for done
`limit`	string	No	Number of results to return (e.g., "50", default: 100, max: 500)
`start`	string	No	Pagination start offset (0-based index of the first item to return)

Output

Parameter	Type	Description
`activities`	array	Array of activity objects from Pipedrive
↳ `id`	number	Activity ID
↳ `subject`	string	Activity subject
↳ `type`	string	Activity type (call, meeting, task, etc.)
↳ `due_date`	string	Due date (YYYY-MM-DD)
↳ `due_time`	string	Due time (HH:MM)
↳ `duration`	string	Duration (HH:MM)
↳ `deal_id`	number	Associated deal ID
↳ `person_id`	number	Associated person ID
↳ `org_id`	number	Associated organization ID
↳ `done`	boolean	Whether the activity is done
↳ `note`	string	Activity note
↳ `add_time`	string	When the activity was created
↳ `update_time`	string	When the activity was last updated
`total_items`	number	Total number of activities returned
`has_more`	boolean	Whether more activities are available
`next_start`	number	Offset for fetching the next page
`success`	boolean	Operation success status

Create Activity in Pipedrive

Create a new activity (task) in Pipedrive

Input

Parameter	Type	Required	Description
`subject`	string	Yes	The subject/title of the activity (e.g., "Follow up call with John")
`type`	string	Yes	Activity type: call, meeting, task, deadline, email, lunch
`due_date`	string	Yes	Due date in YYYY-MM-DD format (e.g., "2025-03-15")
`due_time`	string	No	Due time in HH:MM format (e.g., "14:30")
`duration`	string	No	Duration in HH:MM format (e.g., "01:00" for 1 hour)
`deal_id`	string	No	ID of the deal to associate with (e.g., "123")
`person_id`	string	No	ID of the person to associate with (e.g., "456")
`org_id`	string	No	ID of the organization to associate with (e.g., "789")
`note`	string	No	Notes for the activity

Output

Parameter	Type	Description
`activity`	object	The created activity object
`success`	boolean	Operation success status

Update Activity in Pipedrive

Update an existing activity (task) in Pipedrive

Input

Parameter	Type	Required	Description
`activity_id`	string	Yes	The ID of the activity to update (e.g., "12345")
`subject`	string	No	New subject/title for the activity (e.g., "Updated meeting with client")
`due_date`	string	No	New due date in YYYY-MM-DD format (e.g., "2025-03-20")
`due_time`	string	No	New due time in HH:MM format (e.g., "15:00")
`duration`	string	No	New duration in HH:MM format (e.g., "00:30" for 30 minutes)
`done`	string	No	Mark as done: 0 for not done, 1 for done
`note`	string	No	New notes for the activity

Output

Parameter	Type	Description
`activity`	object	The updated activity object
`success`	boolean	Operation success status

Get Leads from Pipedrive

Retrieve all leads or a specific lead from Pipedrive

Input

Parameter	Type	Required	Description
`lead_id`	string	No	Optional: ID of a specific lead to retrieve (e.g., "abc123-def456-ghi789")
`archived`	string	No	Get archived leads instead of active ones (e.g., "true" or "false")
`owner_id`	string	No	Filter by owner user ID (e.g., "123")
`person_id`	string	No	Filter by person ID (e.g., "456")
`organization_id`	string	No	Filter by organization ID (e.g., "789")
`limit`	string	No	Number of results to return (e.g., "50", default: 100, max: 500)
`start`	string	No	Pagination start offset (0-based index of the first item to return)

Output

Parameter	Type	Description
`leads`	array	Array of lead objects (when listing all)
↳ `id`	string	Lead ID (UUID)
↳ `title`	string	Lead title
↳ `person_id`	number	ID of the associated person
↳ `organization_id`	number	ID of the associated organization
↳ `owner_id`	number	ID of the lead owner
↳ `value`	object	Lead value
↳ `amount`	number	Value amount
↳ `currency`	string	Currency code (e.g., USD, EUR)
↳ `expected_close_date`	string	Expected close date (YYYY-MM-DD)
↳ `is_archived`	boolean	Whether the lead is archived
↳ `was_seen`	boolean	Whether the lead was seen
↳ `add_time`	string	When the lead was created (ISO 8601)
↳ `update_time`	string	When the lead was last updated (ISO 8601)
`lead`	object	Single lead object (when lead_id is provided)
↳ `id`	string	Lead ID (UUID)
↳ `title`	string	Lead title
↳ `person_id`	number	ID of the associated person
↳ `organization_id`	number	ID of the associated organization
↳ `owner_id`	number	ID of the lead owner
↳ `value`	object	Lead value
↳ `amount`	number	Value amount
↳ `currency`	string	Currency code (e.g., USD, EUR)
↳ `expected_close_date`	string	Expected close date (YYYY-MM-DD)
↳ `is_archived`	boolean	Whether the lead is archived
↳ `was_seen`	boolean	Whether the lead was seen
↳ `add_time`	string	When the lead was created (ISO 8601)
↳ `update_time`	string	When the lead was last updated (ISO 8601)
`total_items`	number	Total number of leads returned
`has_more`	boolean	Whether more leads are available
`next_start`	number	Offset for fetching the next page
`success`	boolean	Operation success status

Create Lead in Pipedrive

Create a new lead in Pipedrive

Input

Parameter	Type	Required	Description
`title`	string	Yes	The name of the lead (e.g., "Acme Corp - Website Redesign")
`person_id`	string	No	ID of the person (REQUIRED unless organization_id is provided) (e.g., "456")
`organization_id`	string	No	ID of the organization (REQUIRED unless person_id is provided) (e.g., "789")
`owner_id`	string	No	ID of the user who will own the lead (e.g., "123")
`value_amount`	string	No	Potential value amount (e.g., "10000")
`value_currency`	string	No	Currency code (e.g., "USD", "EUR", "GBP")
`expected_close_date`	string	No	Expected close date in YYYY-MM-DD format (e.g., "2025-04-15")
`visible_to`	string	No	Visibility: 1 (Owner & followers), 3 (Entire company)

Output

Parameter	Type	Description
`lead`	object	The created lead object
`success`	boolean	Operation success status

Update Lead in Pipedrive

Update an existing lead in Pipedrive

Input

Parameter	Type	Required	Description
`lead_id`	string	Yes	The ID of the lead to update (e.g., "abc123-def456-ghi789")
`title`	string	No	New name for the lead (e.g., "Updated Lead - Premium Package")
`person_id`	string	No	New person ID (e.g., "456")
`organization_id`	string	No	New organization ID (e.g., "789")
`owner_id`	string	No	New owner user ID (e.g., "123")
`value_amount`	string	No	New value amount (e.g., "15000")
`value_currency`	string	No	New currency code (e.g., "USD", "EUR", "GBP")
`expected_close_date`	string	No	New expected close date in YYYY-MM-DD format (e.g., "2025-05-01")
`is_archived`	string	No	Archive the lead: true or false

Output

Parameter	Type	Description
`lead`	object	The updated lead object
`success`	boolean	Operation success status

Delete Lead from Pipedrive

Delete a specific lead from Pipedrive

Input

Parameter	Type	Required	Description
`lead_id`	string	Yes	The ID of the lead to delete (e.g., "abc123-def456-ghi789")

Output

Parameter	Type	Description
`data`	object	Deletion confirmation data
`success`	boolean	Operation success status

Convert Lead to Deal in Pipedrive

Start converting a Pipedrive lead into a deal. Returns a conversion ID; the new deal ID is available from the conversion status once the job completes.

Input

Parameter	Type	Required	Description
`lead_id`	string	Yes	ID (UUID) of the lead to convert
`stage_id`	string	No	Stage to place the new deal in. The pipeline follows from the stage
`pipeline_id`	string	No	Pipeline to place the new deal in, at its first stage

Output

Parameter	Type	Description
`conversion_id`	string	ID (UUID) of the conversion job
`success`	boolean	Operation success status

Get Lead Conversion Status from Pipedrive

Check a lead-to-deal conversion job. Returns the status and, once completed, the new deal ID.

Input

Parameter	Type	Required	Description
`lead_id`	string	Yes	ID (UUID) of the converted lead
`conversion_id`	string	Yes	Conversion ID returned by the convert lead operation

Output

Parameter	Type	Description
`conversion_id`	string	ID of the conversion job
`status`	string	Job status: not_started, running, completed, failed, or rejected
`deal_id`	number	ID of the new deal, present once the conversion completed
`lead_id`	string	ID of the lead
`success`	boolean	Operation success status

Create Person in Pipedrive

Create a new person (contact) in Pipedrive with emails, phones, and an organization

Input

Parameter	Type	Required	Description
`name`	string	Yes	Full name of the person (e.g., "Jane Smith")
`email`	string	No	Email address, or several separated by commas. The first is primary (e.g., "jane@acme.com")
`phone`	string	No	Phone number, or several separated by commas. The first is primary (e.g., "+14155550100")
`org_id`	string	No	ID of the organization to link the person to (e.g., "789")
`owner_id`	string	No	ID of the user who owns the person (e.g., "123")
`visible_to`	string	No	Visibility: 1 owner only, 3 entire company, 5 or 7 on Professional plans
`custom_fields`	json	No	Custom field values keyed by the 40-character field hash

Output

Parameter	Type	Description
`person`	object	The created person
↳ `id`	number	Person ID
↳ `name`	string	Full name
↳ `first_name`	string	First name
↳ `last_name`	string	Last name
↳ `owner_id`	number	Owner user ID
↳ `org_id`	number	Linked organization ID
↳ `emails`	array	Email addresses
↳ `value`	string	The email address or phone number
↳ `primary`	boolean	Whether this is the primary entry
↳ `label`	string	Classification label, e.g. work
↳ `phones`	array	Phone numbers
↳ `value`	string	The email address or phone number
↳ `primary`	boolean	Whether this is the primary entry
↳ `label`	string	Classification label, e.g. work
↳ `visible_to`	number	Visibility setting
↳ `label_ids`	array	IDs of labels on the person
↳ `is_deleted`	boolean	Whether the person is deleted
↳ `add_time`	string	When the person was created (ISO 8601)
↳ `update_time`	string	When the person was last updated (ISO 8601)
↳ `custom_fields`	json	Custom field values keyed by the 40-character field hash
`success`	boolean	Operation success status

Update Person in Pipedrive

Update a Pipedrive person. Emails or phones you provide replace the existing list.

Input

Parameter	Type	Required	Description
`person_id`	string	Yes	ID of the person to update (e.g., "456")
`name`	string	No	New full name
`email`	string	No	Replacement email list, separated by commas. The first is primary
`phone`	string	No	Replacement phone list, separated by commas. The first is primary
`org_id`	string	No	ID of the organization to link the person to
`owner_id`	string	No	ID of the new owner user
`visible_to`	string	No	Visibility: 1 owner only, 3 entire company, 5 or 7 on Professional plans
`custom_fields`	json	No	Custom field values keyed by the 40-character field hash

Output

Parameter	Type	Description
`person`	object	The updated person
↳ `id`	number	Person ID
↳ `name`	string	Full name
↳ `first_name`	string	First name
↳ `last_name`	string	Last name
↳ `owner_id`	number	Owner user ID
↳ `org_id`	number	Linked organization ID
↳ `emails`	array	Email addresses
↳ `value`	string	The email address or phone number
↳ `primary`	boolean	Whether this is the primary entry
↳ `label`	string	Classification label, e.g. work
↳ `phones`	array	Phone numbers
↳ `value`	string	The email address or phone number
↳ `primary`	boolean	Whether this is the primary entry
↳ `label`	string	Classification label, e.g. work
↳ `visible_to`	number	Visibility setting
↳ `label_ids`	array	IDs of labels on the person
↳ `is_deleted`	boolean	Whether the person is deleted
↳ `add_time`	string	When the person was created (ISO 8601)
↳ `update_time`	string	When the person was last updated (ISO 8601)
↳ `custom_fields`	json	Custom field values keyed by the 40-character field hash
`success`	boolean	Operation success status

Get Person from Pipedrive

Retrieve a Pipedrive person by ID

Input

Parameter	Type	Required	Description
`person_id`	string	Yes	ID of the person to retrieve (e.g., "456")

Output

Parameter	Type	Description
`person`	object	The person
↳ `id`	number	Person ID
↳ `name`	string	Full name
↳ `first_name`	string	First name
↳ `last_name`	string	Last name
↳ `owner_id`	number	Owner user ID
↳ `org_id`	number	Linked organization ID
↳ `emails`	array	Email addresses
↳ `value`	string	The email address or phone number
↳ `primary`	boolean	Whether this is the primary entry
↳ `label`	string	Classification label, e.g. work
↳ `phones`	array	Phone numbers
↳ `value`	string	The email address or phone number
↳ `primary`	boolean	Whether this is the primary entry
↳ `label`	string	Classification label, e.g. work
↳ `visible_to`	number	Visibility setting
↳ `label_ids`	array	IDs of labels on the person
↳ `is_deleted`	boolean	Whether the person is deleted
↳ `add_time`	string	When the person was created (ISO 8601)
↳ `update_time`	string	When the person was last updated (ISO 8601)
↳ `custom_fields`	json	Custom field values keyed by the 40-character field hash
`success`	boolean	Operation success status

Search Persons in Pipedrive

Search Pipedrive persons by name, email, phone, notes, or custom fields. Use it to match an inbound lead to an existing contact.

Input

Parameter	Type	Required	Description
`term`	string	Yes	Search term, at least 2 characters or 1 with exact match (e.g., "jane@acme.com" or "+14155550100")
`search_fields`	string	No	Comma-separated fields to search: name, email, phone, notes, custom_fields. Defaults to all
`exact_match`	boolean	No	Return only full, case-insensitive exact matches
`org_id`	string	No	Only return persons linked to this organization ID
`limit`	string	No	Number of results (default 100, max 100)
`cursor`	string	No	Pagination cursor from a previous response

Output

Parameter	Type	Description
`items`	array	Matching persons, best match first
↳ `result_score`	number	Search relevancy score
↳ `item`	object	The matching person
↳ `id`	number	Person ID
↳ `type`	string	Item type (person)
↳ `name`	string	Person name
↳ `phones`	array	Phone numbers
↳ `emails`	array	Email addresses
↳ `visible_to`	number	Visibility setting
↳ `owner`	object	Owner of the person
↳ `id`	number	Owner user ID
↳ `organization`	object	Linked organization
↳ `id`	number	Organization ID
↳ `name`	string	Organization name
↳ `custom_fields`	array	Matching custom field values
↳ `notes`	array	Matching notes
`success`	boolean	Operation success status

List Persons in Pipedrive

List Pipedrive persons, optionally filtered by organization, owner, or deal

Input

Parameter	Type	Required	Description
`org_id`	string	No	Only return persons linked to this organization ID
`owner_id`	string	No	Only return persons owned by this user ID
`deal_id`	string	No	Only return persons linked to this deal ID
`updated_since`	string	No	Only return persons updated at or after this RFC 3339 time
`sort_by`	string	No	Sort field: id, update_time, or add_time
`sort_direction`	string	No	Sort direction: asc or desc
`limit`	string	No	Number of results (default 100, max 500)
`cursor`	string	No	Pagination cursor from a previous response

Output

Parameter	Type	Description
`persons`	array	Persons in this page
↳ `id`	number	Person ID
↳ `name`	string	Full name
↳ `first_name`	string	First name
↳ `last_name`	string	Last name
↳ `owner_id`	number	Owner user ID
↳ `org_id`	number	Linked organization ID
↳ `emails`	array	Email addresses
↳ `value`	string	The email address or phone number
↳ `primary`	boolean	Whether this is the primary entry
↳ `label`	string	Classification label, e.g. work
↳ `phones`	array	Phone numbers
↳ `value`	string	The email address or phone number
↳ `primary`	boolean	Whether this is the primary entry
↳ `label`	string	Classification label, e.g. work
↳ `visible_to`	number	Visibility setting
↳ `label_ids`	array	IDs of labels on the person
↳ `is_deleted`	boolean	Whether the person is deleted
↳ `add_time`	string	When the person was created (ISO 8601)
↳ `update_time`	string	When the person was last updated (ISO 8601)
↳ `custom_fields`	json	Custom field values keyed by the 40-character field hash
`success`	boolean	Operation success status

Create Organization in Pipedrive

Create a new organization (company) in Pipedrive

Input

Parameter	Type	Required	Description
`name`	string	Yes	Name of the organization (e.g., "Acme Inc")
`owner_id`	string	No	ID of the user who owns the organization (e.g., "123")
`website`	string	No	Website of the organization (e.g., "https://acme.com")
`address`	string	No	Full address of the organization
`visible_to`	string	No	Visibility: 1 owner only, 3 entire company, 5 or 7 on Professional plans
`custom_fields`	json	No	Custom field values keyed by the 40-character field hash

Output

Parameter	Type	Description
`organization`	object	The created organization
↳ `id`	number	Organization ID
↳ `name`	string	Organization name
↳ `owner_id`	number	Owner user ID
↳ `visible_to`	number	Visibility setting
↳ `address`	object	Organization address
↳ `value`	string	Full address
↳ `country`	string	Country
↳ `admin_area_level_1`	string	State or region
↳ `locality`	string	City
↳ `postal_code`	string	Postal code
↳ `website`	string	Website
↳ `linkedin`	string	LinkedIn profile URL
↳ `industry`	number	Industry option ID
↳ `annual_revenue`	number	Annual revenue
↳ `employee_count`	number	Number of employees
↳ `label_ids`	array	IDs of labels on the organization
↳ `is_deleted`	boolean	Whether the organization is deleted
↳ `add_time`	string	When the organization was created (ISO 8601)
↳ `update_time`	string	When the organization was last updated (ISO 8601)
↳ `custom_fields`	json	Custom field values keyed by the 40-character field hash
`success`	boolean	Operation success status

Update Organization in Pipedrive

Update an existing Pipedrive organization

Input

Parameter	Type	Required	Description
`org_id`	string	Yes	ID of the organization to update (e.g., "789")
`name`	string	No	New organization name
`owner_id`	string	No	ID of the new owner user
`website`	string	No	New website
`address`	string	No	New full address
`visible_to`	string	No	Visibility: 1 owner only, 3 entire company, 5 or 7 on Professional plans
`custom_fields`	json	No	Custom field values keyed by the 40-character field hash

Output

Parameter	Type	Description
`organization`	object	The updated organization
↳ `id`	number	Organization ID
↳ `name`	string	Organization name
↳ `owner_id`	number	Owner user ID
↳ `visible_to`	number	Visibility setting
↳ `address`	object	Organization address
↳ `value`	string	Full address
↳ `country`	string	Country
↳ `admin_area_level_1`	string	State or region
↳ `locality`	string	City
↳ `postal_code`	string	Postal code
↳ `website`	string	Website
↳ `linkedin`	string	LinkedIn profile URL
↳ `industry`	number	Industry option ID
↳ `annual_revenue`	number	Annual revenue
↳ `employee_count`	number	Number of employees
↳ `label_ids`	array	IDs of labels on the organization
↳ `is_deleted`	boolean	Whether the organization is deleted
↳ `add_time`	string	When the organization was created (ISO 8601)
↳ `update_time`	string	When the organization was last updated (ISO 8601)
↳ `custom_fields`	json	Custom field values keyed by the 40-character field hash
`success`	boolean	Operation success status

Get Organization from Pipedrive

Retrieve a Pipedrive organization by ID

Input

Parameter	Type	Required	Description
`org_id`	string	Yes	ID of the organization to retrieve (e.g., "789")

Output

Parameter	Type	Description
`organization`	object	The organization
↳ `id`	number	Organization ID
↳ `name`	string	Organization name
↳ `owner_id`	number	Owner user ID
↳ `visible_to`	number	Visibility setting
↳ `address`	object	Organization address
↳ `value`	string	Full address
↳ `country`	string	Country
↳ `admin_area_level_1`	string	State or region
↳ `locality`	string	City
↳ `postal_code`	string	Postal code
↳ `website`	string	Website
↳ `linkedin`	string	LinkedIn profile URL
↳ `industry`	number	Industry option ID
↳ `annual_revenue`	number	Annual revenue
↳ `employee_count`	number	Number of employees
↳ `label_ids`	array	IDs of labels on the organization
↳ `is_deleted`	boolean	Whether the organization is deleted
↳ `add_time`	string	When the organization was created (ISO 8601)
↳ `update_time`	string	When the organization was last updated (ISO 8601)
↳ `custom_fields`	json	Custom field values keyed by the 40-character field hash
`success`	boolean	Operation success status

Search Organizations in Pipedrive

Search Pipedrive organizations by name, address, notes, or custom fields

Input

Parameter	Type	Required	Description
`term`	string	Yes	Search term, at least 2 characters or 1 with exact match (e.g., "Acme")
`search_fields`	string	No	Comma-separated fields to search: name, address, notes, custom_fields. Defaults to all
`exact_match`	boolean	No	Return only full, case-insensitive exact matches
`limit`	string	No	Number of results (default 100, max 100)
`cursor`	string	No	Pagination cursor from a previous response

Output

Parameter	Type	Description
`items`	array	Matching organizations, best match first
↳ `result_score`	number	Search relevancy score
↳ `item`	object	The matching organization
↳ `id`	number	Organization ID
↳ `type`	string	Item type (organization)
↳ `name`	string	Organization name
↳ `address`	string	Organization address
↳ `visible_to`	number	Visibility setting
↳ `owner`	object	Owner of the organization
↳ `id`	number	Owner user ID
↳ `custom_fields`	array	Matching custom field values
↳ `notes`	array	Matching notes
`success`	boolean	Operation success status

Create Note in Pipedrive

Add a note to a Pipedrive deal, person, organization, or lead

Input

Parameter	Type	Required	Description
`content`	string	Yes	Note content. HTML is allowed and sanitized by Pipedrive
`deal_id`	string	No	ID of the deal to attach the note to
`person_id`	string	No	ID of the person to attach the note to
`org_id`	string	No	ID of the organization to attach the note to
`lead_id`	string	No	ID (UUID) of the lead to attach the note to

Output

Parameter	Type	Description
`note`	object	The created note
↳ `id`	number	Note ID
↳ `content`	string	Note content (HTML)
↳ `deal_id`	number	Attached deal ID
↳ `person_id`	number	Attached person ID
↳ `org_id`	number	Attached organization ID
↳ `lead_id`	string	Attached lead ID
↳ `user_id`	number	Author user ID
↳ `active_flag`	boolean	Whether the note is active
↳ `add_time`	string	When the note was created
↳ `update_time`	string	When the note was last updated
`success`	boolean	Operation success status

Triggers

A Trigger is a block that starts a workflow when an event happens in this service.

Pipedrive Webhook

Trigger a workflow when Pipedrive deals, persons, organizations, leads, activities, or other records are created, updated, or deleted.

Pipedrive

On this page