Add new activity type Adds a new activity type.

Lua path

app.integrations.pipedrive.add_new_activity_type

Full name

pipedrive.pipedrive_add_activity_type

Add a call log Adds a new call log.

Lua path

app.integrations.pipedrive.add_call_log

Full name

pipedrive.pipedrive_add_call_log

Attach an audio file to the call log Adds an audio recording to the call log. That audio can be played by those who have access to the call log object.

Lua path

app.integrations.pipedrive.attach_audio_file_call_log

Full name

pipedrive.pipedrive_add_call_log_audio_file

Add a channel Adds a new messaging channel, only admins are able to register new channels. It will use the getConversations endpoint to fetch conversations, participants and messages afterward. To use the endpoint, you need to have **Messengers integration** OAuth scope enabled and the Messaging manifest ready for the [Messaging app extension](https://pipedrive.readme.io/docs/messaging-app-extension).

Lua path

app.integrations.pipedrive.add_channel

Full name

pipedrive.pipedrive_add_channel

Add a new deal field Adds a new deal field. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/adding-a-new-custom-field" target="_blank" rel="noopener noreferrer">adding a new custom field</a>.

Lua path

app.integrations.pipedrive.add_new_deal_field

Full name

pipedrive.pipedrive_add_deal_field

Add a follower to a deal Adds a follower to a deal.

Lua path

app.integrations.pipedrive.add_follower_deal

Full name

pipedrive.pipedrive_add_deal_follower

Add a participant to a deal Adds a participant to a deal.

Lua path

app.integrations.pipedrive.add_participant_deal

Full name

pipedrive.pipedrive_add_deal_participant

Add file Lets you upload a file and associate it with a deal, person, organization, activity, product or lead. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/adding-a-file" target="_blank" rel="noopener noreferrer">adding a file</a>.

Lua path

app.integrations.pipedrive.add_file

Full name

pipedrive.pipedrive_add_file

Create a remote file and link it to an item Creates a new empty file in the remote location (`googledrive`) that will be linked to the item you supply. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/adding-a-remote-file" target="_blank" rel="noopener noreferrer">adding a remote file</a>.

Lua path

app.integrations.pipedrive.create_remote_file_and_link_it_item

Full name

pipedrive.pipedrive_add_file_and_link_it

Add a new filter Adds a new filter, returns the ID upon success. Note that in the conditions JSON object only one first-level condition group is supported, and it must be glued with 'AND', and only two second level condition groups are supported of which one must be glued with 'AND' and the second with 'OR'. Other combinations do not work (yet) but the syntax supports introducing them in future. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/adding-a-filter" target="_blank" rel="noopener noreferrer">adding a filter</a>.

Lua path

app.integrations.pipedrive.add_new_filter

Full name

pipedrive.pipedrive_add_filter

Add a new goal Adds a new goal. Along with adding a new goal, a report is created to track the progress of your goal.

Lua path

app.integrations.pipedrive.add_new_goal

Full name

pipedrive.pipedrive_add_goal

Add a lead Creates a lead. A lead always has to be linked to a person or an organization or both. All leads created through the Pipedrive API will have a lead source and origin set to `API`. Here's the tutorial for <a href="https://pipedrive.readme.io/docs/adding-a-lead" target="_blank" rel="noopener noreferrer">adding a lead</a>. If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields' structure from deals. See an example given in the <a href="https://pipedrive.readme.io/docs/updating-custom-field-value" target="_blank" rel="noopener noreferrer">updating custom fields' values tutorial</a>.

Lua path

app.integrations.pipedrive.add_lead

Full name

pipedrive.pipedrive_add_lead

Add a lead label Creates a lead label.

Lua path

app.integrations.pipedrive.add_lead_label

Full name

pipedrive.pipedrive_add_lead_label

Add a comment to a note Adds a new comment to a note.

Lua path

app.integrations.pipedrive.add_comment_note

Full name

pipedrive.pipedrive_add_note_comment

Add or update role setting Adds or updates the visibility setting for a role.

Lua path

app.integrations.pipedrive.add_or_update_role_setting

Full name

pipedrive.pipedrive_add_or_update_role_setting

Add a new organization field Adds a new organization field. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/adding-a-new-custom-field" target="_blank" rel="noopener noreferrer">adding a new custom field</a>.

Lua path

app.integrations.pipedrive.add_new_organization_field

Full name

pipedrive.pipedrive_add_organization_field

Add a follower to an organization Adds a follower to an organization.

Lua path

app.integrations.pipedrive.add_follower_organization

Full name

pipedrive.pipedrive_add_organization_follower

Create an organization relationship Creates and returns an organization relationship.

Lua path

app.integrations.pipedrive.create_organization_relationship

Full name

pipedrive.pipedrive_add_organization_relationship

Add a new person field Adds a new person field. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/adding-a-new-custom-field" target="_blank" rel="noopener noreferrer">adding a new custom field</a>.

Lua path

app.integrations.pipedrive.add_new_person_field

Full name

pipedrive.pipedrive_add_person_field

Add a follower to a person Adds a follower to a person.

Lua path

app.integrations.pipedrive.add_follower_person

Full name

pipedrive.pipedrive_add_person_follower

Add person picture Adds a picture to a person. If a picture is already set, the old picture will be replaced. Added image (or the cropping parameters supplied with the request) should have an equal width and height and should be at least 128 pixels. GIF, JPG and PNG are accepted. All added images will be resized to 128 and 512 pixel wide squares.

Lua path

app.integrations.pipedrive.add_person_picture

Full name

pipedrive.pipedrive_add_person_picture

Add a new product field Adds a new product field. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/adding-a-new-custom-field" target="_blank" rel="noopener noreferrer">adding a new custom field</a>.

Lua path

app.integrations.pipedrive.add_new_product_field

Full name

pipedrive.pipedrive_add_product_field

Add a follower to a product Adds a follower to a product.

Lua path

app.integrations.pipedrive.add_follower_product

Full name

pipedrive.pipedrive_add_product_follower

Add a project Adds a new project. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys.

Lua path

app.integrations.pipedrive.add_project

Full name

pipedrive.pipedrive_add_project

Add a role Adds a new role.

Lua path

app.integrations.pipedrive.add_role

Full name

pipedrive.pipedrive_add_role

Add role assignment Assigns a user to a role.

Lua path

app.integrations.pipedrive.add_role_assignment

Full name

pipedrive.pipedrive_add_role_assignment

Add a task Adds a new task.

Lua path

app.integrations.pipedrive.add_task

Full name

pipedrive.pipedrive_add_task

Add a new team Adds a new team to the company and returns the created object.

Lua path

app.integrations.pipedrive.add_new_team

Full name

pipedrive.pipedrive_add_team

Add users to a team Adds users to an existing team.

Lua path

app.integrations.pipedrive.add_users_team

Full name

pipedrive.pipedrive_add_team_user

Add a new user Adds a new user to the company, returns the ID upon success.

Lua path

app.integrations.pipedrive.add_new_user

Full name

pipedrive.pipedrive_add_user

Create a new Webhook Creates a new Webhook and returns its details. Note that specifying an event which triggers the Webhook combines 2 parameters - `event_action` and `event_object`. E.g., use `*.*` for getting notifications about all events, `create.deal` for any newly added deals, `delete.persons` for any deleted persons, etc. See <a href="https://pipedrive.readme.io/docs/guide-for-webhooks-v2?ref=api_reference" target="_blank" rel="noopener noreferrer">the guide for Webhooks</a> for more details.

Lua path

app.integrations.pipedrive.create_new_webhook

Full name

pipedrive.pipedrive_add_webhook

Archive a project Archives a project.

Lua path

app.integrations.pipedrive.archive_project

Full name

pipedrive.pipedrive_archive_project

Requesting authorization Authorize a user by redirecting them to the Pipedrive OAuth authorization page and request their permissions to act on their behalf. This step is necessary to implement only when you allow app installation outside of the Marketplace.

Lua path

app.integrations.pipedrive.requesting_authorization

Full name

pipedrive.pipedrive_authorize

Add a new deal Adds a new deal.

Lua path

app.integrations.pipedrive.add_new_deal

Full name

pipedrive.pipedrive_create_deal

Add a note Adds a new note.

Lua path

app.integrations.pipedrive.add_note

Full name

pipedrive.pipedrive_create_note

Add a new organization Adds a new organization.

Lua path

app.integrations.pipedrive.add_new_organization

Full name

pipedrive.pipedrive_create_organization

Add a new person Adds a new person. If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.

Lua path

app.integrations.pipedrive.add_new_person

Full name

pipedrive.pipedrive_create_person

Delete an activity type Marks an activity type as deleted.

Lua path

app.integrations.pipedrive.delete_activity_type

Full name

pipedrive.pipedrive_delete_activity_type

Delete a call log Deletes a call log. If there is an audio recording attached to it, it will also be deleted. The related activity will not be removed by this request. If you want to remove the related activities, please use the endpoint which is specific for activities.

Lua path

app.integrations.pipedrive.delete_call_log

Full name

pipedrive.pipedrive_delete_call_log

Delete a channel Deletes an existing messenger's channel and all related entities (conversations and messages). To use the endpoint, you need to have **Messengers integration** OAuth scope enabled and the Messaging manifest ready for the [Messaging app extension](https://pipedrive.readme.io/docs/messaging-app-extension).

Lua path

app.integrations.pipedrive.delete_channel

Full name

pipedrive.pipedrive_delete_channel

Delete a comment related to a note Deletes a comment.

Lua path

app.integrations.pipedrive.delete_comment_related_note

Full name

pipedrive.pipedrive_delete_comment

Delete a conversation Deletes an existing conversation. To use the endpoint, you need to have **Messengers integration** OAuth scope enabled and the Messaging manifest ready for the [Messaging app extension](https://pipedrive.readme.io/docs/messaging-app-extension).

Lua path

app.integrations.pipedrive.delete_conversation

Full name

pipedrive.pipedrive_delete_conversation

Delete a deal field Marks a field as deleted. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/deleting-a-custom-field" target="_blank" rel="noopener noreferrer">deleting a custom field</a>.

Lua path

app.integrations.pipedrive.delete_deal_field

Full name

pipedrive.pipedrive_delete_deal_field

Delete multiple deal fields in bulk Marks multiple deal fields as deleted.

Lua path

app.integrations.pipedrive.delete_multiple_deal_fields_bulk

Full name

pipedrive.pipedrive_delete_deal_fields

Delete a follower from a deal Deletes a follower from a deal.

Lua path

app.integrations.pipedrive.delete_follower_from_deal

Full name

pipedrive.pipedrive_delete_deal_follower

Delete a participant from a deal Deletes a participant from a deal.

Lua path

app.integrations.pipedrive.delete_participant_from_deal

Full name

pipedrive.pipedrive_delete_deal_participant

Delete a file Marks a file as deleted. After 30 days, the file will be permanently deleted.

Lua path

app.integrations.pipedrive.delete_file

Full name

pipedrive.pipedrive_delete_file

Delete a filter Marks a filter as deleted.

Lua path

app.integrations.pipedrive.delete_filter

Full name

pipedrive.pipedrive_delete_filter

Delete multiple filters in bulk Marks multiple filters as deleted.

Lua path

app.integrations.pipedrive.delete_multiple_filters_bulk

Full name

pipedrive.pipedrive_delete_filters

Delete existing goal Marks a goal as deleted.

Lua path

app.integrations.pipedrive.delete_existing_goal

Full name

pipedrive.pipedrive_delete_goal

Delete a lead Deletes a specific lead.

Lua path

app.integrations.pipedrive.delete_lead

Full name

pipedrive.pipedrive_delete_lead

Delete a lead label Deletes a specific lead label.

Lua path

app.integrations.pipedrive.delete_lead_label

Full name

pipedrive.pipedrive_delete_lead_label

Delete mail thread Marks a mail thread as deleted.

Lua path

app.integrations.pipedrive.delete_mail_thread

Full name

pipedrive.pipedrive_delete_mail_thread

Delete a note Deletes a specific note.

Lua path

app.integrations.pipedrive.delete_note

Full name

pipedrive.pipedrive_delete_note

Delete an organization field Marks a field as deleted. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/deleting-a-custom-field" target="_blank" rel="noopener noreferrer">deleting a custom field</a>.

Lua path

app.integrations.pipedrive.delete_organization_field

Full name

pipedrive.pipedrive_delete_organization_field

Delete multiple organization fields in bulk Marks multiple fields as deleted.

Lua path

app.integrations.pipedrive.delete_multiple_organization_fields_bulk

Full name

pipedrive.pipedrive_delete_organization_fields

Delete a follower from an organization Deletes a follower from an organization. You can retrieve the `follower_id` from the <a href="https://developers.pipedrive.com/docs/api/v1/Organizations#getOrganizationFollowers">List followers of an organization</a> endpoint.

Lua path

app.integrations.pipedrive.delete_follower_from_organization

Full name

pipedrive.pipedrive_delete_organization_follower

Delete an organization relationship Deletes an organization relationship and returns the deleted ID.

Lua path

app.integrations.pipedrive.delete_organization_relationship

Full name

pipedrive.pipedrive_delete_organization_relationship

Delete a person field Marks a field as deleted. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/deleting-a-custom-field" target="_blank" rel="noopener noreferrer">deleting a custom field</a>.

Lua path

app.integrations.pipedrive.delete_person_field

Full name

pipedrive.pipedrive_delete_person_field

Delete multiple person fields in bulk Marks multiple fields as deleted.

Lua path

app.integrations.pipedrive.delete_multiple_person_fields_bulk

Full name

pipedrive.pipedrive_delete_person_fields

Delete a follower from a person Deletes a follower from a person.

Lua path

app.integrations.pipedrive.delete_follower_from_person

Full name

pipedrive.pipedrive_delete_person_follower

Delete person picture Deletes a person's picture.

Lua path

app.integrations.pipedrive.delete_person_picture

Full name

pipedrive.pipedrive_delete_person_picture

Delete a product field Marks a product field as deleted. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/deleting-a-custom-field" target="_blank" rel="noopener noreferrer">deleting a custom field</a>.

Lua path

app.integrations.pipedrive.delete_product_field

Full name

pipedrive.pipedrive_delete_product_field

Delete multiple product fields in bulk Marks multiple fields as deleted.

Lua path

app.integrations.pipedrive.delete_multiple_product_fields_bulk

Full name

pipedrive.pipedrive_delete_product_fields

Delete a follower from a product Deletes a follower from a product.

Lua path

app.integrations.pipedrive.delete_follower_from_product

Full name

pipedrive.pipedrive_delete_product_follower

Delete a project Marks a project as deleted.

Lua path

app.integrations.pipedrive.delete_project

Full name

pipedrive.pipedrive_delete_project

Delete a role Marks a role as deleted.

Lua path

app.integrations.pipedrive.delete_role

Full name

pipedrive.pipedrive_delete_role

Delete a role assignment Removes the assigned user from a role and adds to the default role.

Lua path

app.integrations.pipedrive.delete_role_assignment

Full name

pipedrive.pipedrive_delete_role_assignment

Delete a task Marks a task as deleted. If the task has subtasks then those will also be deleted.

Lua path

app.integrations.pipedrive.delete_task

Full name

pipedrive.pipedrive_delete_task

Delete users from a team Deletes users from an existing team.

Lua path

app.integrations.pipedrive.delete_users_from_team

Full name

pipedrive.pipedrive_delete_team_user

Delete the link between a user and the installed video call integration A video calling provider must call this endpoint to remove the link between a user and the installed video calling app.

Lua path

app.integrations.pipedrive.delete_link_between_user_and_installed_video_call_integration

Full name

pipedrive.pipedrive_delete_user_provider_link

Delete existing Webhook Deletes the specified Webhook.

Lua path

app.integrations.pipedrive.delete_existing_webhook

Full name

pipedrive.pipedrive_delete_webhook

Download one file Initializes a file download.

Lua path

app.integrations.pipedrive.download_one_file

Full name

pipedrive.pipedrive_download_file

Duplicate deal Duplicates a deal.

Lua path

app.integrations.pipedrive.duplicate_deal

Full name

pipedrive.pipedrive_duplicate_deal

Find users by name Finds users by their name.

Lua path

app.integrations.pipedrive.find_users_by_name

Full name

pipedrive.pipedrive_find_users_by_name

Get all activity fields Returns all activity fields.

Lua path

app.integrations.pipedrive.get_all_activity_fields

Full name

pipedrive.pipedrive_get_activity_fields

Get all activity types Returns all activity types.

Lua path

app.integrations.pipedrive.get_all_activity_types

Full name

pipedrive.pipedrive_get_activity_types

Get all archived deals Returns all archived deals.

Lua path

app.integrations.pipedrive.get_all_archived_deals

Full name

pipedrive.pipedrive_get_archived_deals

Get archived deals summary Returns a summary of all archived deals.

Lua path

app.integrations.pipedrive.get_archived_deals_summary

Full name

pipedrive.pipedrive_get_archived_deals_summary

Get archived deals timeline Returns archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) - e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups - January, February and March - based on the value of the given `field_key`.

Lua path

app.integrations.pipedrive.get_archived_deals_timeline

Full name

pipedrive.pipedrive_get_archived_deals_timeline

Get all archived leads Returns multiple archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields' structure from deals.

Lua path

app.integrations.pipedrive.get_all_archived_leads

Full name

pipedrive.pipedrive_get_archived_leads

Get details of a call log Returns details of a specific call log.

Lua path

app.integrations.pipedrive.get_details_call_log

Full name

pipedrive.pipedrive_get_call_log

Get one comment Returns the details of a comment.

Lua path

app.integrations.pipedrive.get_one_comment

Full name

pipedrive.pipedrive_get_comment

Get all add-ons for a single company Returns the add-ons for a single company.

Lua path

app.integrations.pipedrive.get_all_add_ons_single_company

Full name

pipedrive.pipedrive_get_company_addons

Get all supported currencies Returns all supported currencies in given account which should be used when saving monetary values with other objects. The `code` parameter of the returning objects is the currency code according to ISO 4217 for all non-custom currencies.

Lua path

app.integrations.pipedrive.get_all_supported_currencies

Full name

pipedrive.pipedrive_get_currencies

Get current user data Returns data about an authorized user within the company with bound company data: company ID, company name, and domain. Note that the `locale` property means 'Date/number format' in the Pipedrive account settings, not the chosen language.

Lua path

app.integrations.pipedrive.get_current_user_data

Full name

pipedrive.pipedrive_get_current_user

Get details of a deal Returns the details of a specific deal.

Lua path

app.integrations.pipedrive.get_details_deal

Full name

pipedrive.pipedrive_get_deal

List updates about deal field values Lists updates about field values of a deal.

Lua path

app.integrations.pipedrive.list_updates_about_deal_field_values

Full name

pipedrive.pipedrive_get_deal_changelog

Get one deal field Returns data about a specific deal field.

Lua path

app.integrations.pipedrive.get_one_deal_field

Full name

pipedrive.pipedrive_get_deal_field

Get all deal fields Returns data about all deal fields.

Lua path

app.integrations.pipedrive.get_all_deal_fields

Full name

pipedrive.pipedrive_get_deal_fields

List files attached to a deal Lists files associated with a deal.

Lua path

app.integrations.pipedrive.list_files_attached_deal

Full name

pipedrive.pipedrive_get_deal_files

List followers of a deal Lists the followers of a deal.

Lua path

app.integrations.pipedrive.list_followers_deal

Full name

pipedrive.pipedrive_get_deal_followers

List mail messages associated with a deal Lists mail messages associated with a deal.

Lua path

app.integrations.pipedrive.list_mail_messages_associated_with_deal

Full name

pipedrive.pipedrive_get_deal_mail_messages

List participants of a deal Lists the participants associated with a deal.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.

Lua path

app.integrations.pipedrive.list_participants_deal

Full name

pipedrive.pipedrive_get_deal_participants

List updates about participants of a deal. This is a cursor-paginated endpoint. For more information, please refer to our documentation on <a href="https://pipedrive.readme.io/docs/core-api-concepts-pagination" target="_blank" rel="noopener noreferrer">pagination</a>.

Lua path

app.integrations.pipedrive.list_updates_about_participants_deal

Full name

pipedrive.pipedrive_get_deal_participants_changelog

List updates about a deal Lists updates about a deal.

Lua path

app.integrations.pipedrive.list_updates_about_deal

Full name

pipedrive.pipedrive_get_deal_updates

List permitted users Lists the users permitted to access a deal.

Lua path

app.integrations.pipedrive.list_permitted_users

Full name

pipedrive.pipedrive_get_deal_users

Get deals summary Returns a summary of all not archived deals.

Lua path

app.integrations.pipedrive.get_deals_summary

Full name

pipedrive.pipedrive_get_deals_summary

Get deals timeline Returns not archived open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) - e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups - January, February and March - based on the value of the given `field_key`.

Lua path

app.integrations.pipedrive.get_deals_timeline

Full name

pipedrive.pipedrive_get_deals_timeline

Get one file Returns data about a specific file.

Lua path

app.integrations.pipedrive.get_one_file

Full name

pipedrive.pipedrive_get_file

Get all files Returns data about all files.

Lua path

app.integrations.pipedrive.get_all_files

Full name

pipedrive.pipedrive_get_files

Get one filter Returns data about a specific filter. Note that this also returns the condition lines of the filter.

Lua path

app.integrations.pipedrive.get_one_filter

Full name

pipedrive.pipedrive_get_filter

Get all filter helpers Returns all supported filter helpers. It helps to know what conditions and helpers are available when you want to <a href="/docs/api/v1/Filters#addFilter">add</a> or <a href="/docs/api/v1/Filters#updateFilter">update</a> filters. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/adding-a-filter" target="_blank" rel="noopener noreferrer">adding a filter</a>.

Lua path

app.integrations.pipedrive.get_all_filter_helpers

Full name

pipedrive.pipedrive_get_filter_helpers

Get all filters Returns data about all filters.

Lua path

app.integrations.pipedrive.get_all_filters

Full name

pipedrive.pipedrive_get_filters

Get result of a goal Gets the progress of a goal for the specified period.

Lua path

app.integrations.pipedrive.get_result_goal

Full name

pipedrive.pipedrive_get_goal_result

Find goals Returns data about goals based on criteria. For searching, append `{searchField}={searchValue}` to the URL, where `searchField` can be any one of the lowest-level fields in dot-notation (e.g. `type.params.pipeline_id`; `title`). `searchValue` should be the value you are looking for on that field. Additionally, `is_active=<true|false>` can be provided to search for only active/inactive goals. When providing `period.start`, `period.end` must also be provided and vice versa.

Lua path

app.integrations.pipedrive.find_goals

Full name

pipedrive.pipedrive_get_goals

Get one lead Returns details of a specific lead. If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields' structure from deals.

Lua path

app.integrations.pipedrive.get_one_lead

Full name

pipedrive.pipedrive_get_lead

Get all lead fields Returns data about all lead fields.

Lua path

app.integrations.pipedrive.get_all_lead_fields

Full name

pipedrive.pipedrive_get_lead_fields

Get all lead labels Returns details of all lead labels. This endpoint does not support pagination and all labels are always returned.

Lua path

app.integrations.pipedrive.get_all_lead_labels

Full name

pipedrive.pipedrive_get_lead_labels

Get all lead sources Returns all lead sources. Please note that the list of lead sources is fixed, it cannot be modified. All leads created through the Pipedrive API will have a lead source `API` assigned.

Lua path

app.integrations.pipedrive.get_all_lead_sources

Full name

pipedrive.pipedrive_get_lead_sources

List permitted users Lists the users permitted to access a lead.

Lua path

app.integrations.pipedrive.list_permitted_users

Full name

pipedrive.pipedrive_get_lead_users

Get all leads Returns multiple not archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields' structure from deals.

Lua path

app.integrations.pipedrive.get_all_leads

Full name

pipedrive.pipedrive_get_leads

Get one mail message Returns data about a specific mail message.

Lua path

app.integrations.pipedrive.get_one_mail_message

Full name

pipedrive.pipedrive_get_mail_message

Get one mail thread Returns a specific mail thread.

Lua path

app.integrations.pipedrive.get_one_mail_thread

Full name

pipedrive.pipedrive_get_mail_thread

Get all mail messages of mail thread Returns all the mail messages inside a specified mail thread.

Lua path

app.integrations.pipedrive.get_all_mail_messages_mail_thread

Full name

pipedrive.pipedrive_get_mail_thread_messages

Get mail threads Returns mail threads in a specified folder ordered by the most recent message within.

Lua path

app.integrations.pipedrive.get_mail_threads

Full name

pipedrive.pipedrive_get_mail_threads

Get one note Returns details about a specific note.

Lua path

app.integrations.pipedrive.get_one_note

Full name

pipedrive.pipedrive_get_note

Get all comments for a note Returns all comments associated with a note.

Lua path

app.integrations.pipedrive.get_all_comments_note

Full name

pipedrive.pipedrive_get_note_comments

Get all note fields Returns data about all note fields.

Lua path

app.integrations.pipedrive.get_all_note_fields

Full name

pipedrive.pipedrive_get_note_fields

Get all notes Returns all notes.

Lua path

app.integrations.pipedrive.get_all_notes

Full name

pipedrive.pipedrive_get_notes

Get details of a organization Returns the details of a specific organization.

Lua path

app.integrations.pipedrive.get_details_organization

Full name

pipedrive.pipedrive_get_organization

List updates about organization field values Lists updates about field values of an organization.

Lua path

app.integrations.pipedrive.list_updates_about_organization_field_values

Full name

pipedrive.pipedrive_get_organization_changelog

Get one organization field Returns data about a specific organization field.

Lua path

app.integrations.pipedrive.get_one_organization_field

Full name

pipedrive.pipedrive_get_organization_field

Get all organization fields Returns data about all organization fields.

Lua path

app.integrations.pipedrive.get_all_organization_fields

Full name

pipedrive.pipedrive_get_organization_fields

List files attached to an organization Lists files associated with an organization.

Lua path

app.integrations.pipedrive.list_files_attached_organization

Full name

pipedrive.pipedrive_get_organization_files

List followers of an organization Lists the followers of an organization.

Lua path

app.integrations.pipedrive.list_followers_organization

Full name

pipedrive.pipedrive_get_organization_followers

List mail messages associated with an organization Lists mail messages associated with an organization.

Lua path

app.integrations.pipedrive.list_mail_messages_associated_with_organization

Full name

pipedrive.pipedrive_get_organization_mail_messages

Get one organization relationship Finds and returns an organization relationship from its ID.

Lua path

app.integrations.pipedrive.get_one_organization_relationship

Full name

pipedrive.pipedrive_get_organization_relationship

Get all relationships for organization Gets all of the relationships for a supplied organization ID.

Lua path

app.integrations.pipedrive.get_all_relationships_organization

Full name

pipedrive.pipedrive_get_organization_relationships

List updates about an organization Lists updates about an organization.

Lua path

app.integrations.pipedrive.list_updates_about_organization

Full name

pipedrive.pipedrive_get_organization_updates

List permitted users List users permitted to access an organization.

Lua path

app.integrations.pipedrive.list_permitted_users

Full name

pipedrive.pipedrive_get_organization_users

Get one permission set Returns data about a specific permission set.

Lua path

app.integrations.pipedrive.get_one_permission_set

Full name

pipedrive.pipedrive_get_permission_set

List permission set assignments Returns the list of assignments for a permission set.

Lua path

app.integrations.pipedrive.list_permission_set_assignments

Full name

pipedrive.pipedrive_get_permission_set_assignments

Get all permission sets Returns data about all permission sets.

Lua path

app.integrations.pipedrive.get_all_permission_sets

Full name

pipedrive.pipedrive_get_permission_sets

Get details of a person Returns the details of a specific person. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.

Lua path

app.integrations.pipedrive.get_details_person

Full name

pipedrive.pipedrive_get_person

List updates about person field values Lists updates about field values of a person.

Lua path

app.integrations.pipedrive.list_updates_about_person_field_values

Full name

pipedrive.pipedrive_get_person_changelog

Get one person field Returns data about a specific person field.

Lua path

app.integrations.pipedrive.get_one_person_field

Full name

pipedrive.pipedrive_get_person_field

Get all person fields Returns data about all person fields.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.

Lua path

app.integrations.pipedrive.get_all_person_fields

Full name

pipedrive.pipedrive_get_person_fields

List files attached to a person Lists files associated with a person.

Lua path

app.integrations.pipedrive.list_files_attached_person

Full name

pipedrive.pipedrive_get_person_files

List followers of a person Lists the followers of a person.

Lua path

app.integrations.pipedrive.list_followers_person

Full name

pipedrive.pipedrive_get_person_followers

List mail messages associated with a person Lists mail messages associated with a person.

Lua path

app.integrations.pipedrive.list_mail_messages_associated_with_person

Full name

pipedrive.pipedrive_get_person_mail_messages

List products associated with a person Lists products associated with a person.

Lua path

app.integrations.pipedrive.list_products_associated_with_person

Full name

pipedrive.pipedrive_get_person_products

List updates about a person Lists updates about a person.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint's response will also include updates for the `marketing_status` field.

Lua path

app.integrations.pipedrive.list_updates_about_person

Full name

pipedrive.pipedrive_get_person_updates

List permitted users List users permitted to access a person.

Lua path

app.integrations.pipedrive.list_permitted_users

Full name

pipedrive.pipedrive_get_person_users

Get deals conversion rates in pipeline Returns all stage-to-stage conversion and pipeline-to-close rates for the given time period.

Lua path

app.integrations.pipedrive.get_deals_conversion_rates_pipeline

Full name

pipedrive.pipedrive_get_pipeline_conversion_statistics

Get deals in a pipeline Lists deals in a specific pipeline across all its stages. If no parameters are provided open deals owned by the authorized user will be returned. <br>This endpoint has been deprecated. Please use <a href="https://developers.pipedrive.com/docs/api/v1/Deals#getDeals" target="_blank" rel="noopener noreferrer">GET /api/v2/deals?pipeline_id={id}</a> instead.

Lua path

app.integrations.pipedrive.get_deals_pipeline

Full name

pipedrive.pipedrive_get_pipeline_deals

Get deals movements in pipeline Returns statistics for deals movements for the given time period.

Lua path

app.integrations.pipedrive.get_deals_movements_pipeline

Full name

pipedrive.pipedrive_get_pipeline_movement_statistics

Get deals where a product is attached to Returns data about deals that have a product attached to it.

Lua path

app.integrations.pipedrive.get_deals_where_product_attached

Full name

pipedrive.pipedrive_get_product_deals

Get one product field Returns data about a specific product field.

Lua path

app.integrations.pipedrive.get_one_product_field

Full name

pipedrive.pipedrive_get_product_field

Get all product fields Returns data about all product fields.

Lua path

app.integrations.pipedrive.get_all_product_fields

Full name

pipedrive.pipedrive_get_product_fields

List files attached to a product Lists files associated with a product.

Lua path

app.integrations.pipedrive.list_files_attached_product

Full name

pipedrive.pipedrive_get_product_files

List followers of a product Lists the followers of a product.

Lua path

app.integrations.pipedrive.list_followers_product

Full name

pipedrive.pipedrive_get_product_followers

List permitted users Lists users permitted to access a product.

Lua path

app.integrations.pipedrive.list_permitted_users

Full name

pipedrive.pipedrive_get_product_users

Get details of a project Returns the details of a specific project. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of project fields.

Lua path

app.integrations.pipedrive.get_details_project

Full name

pipedrive.pipedrive_get_project

Returns project activities Returns activities linked to a specific project.

Lua path

app.integrations.pipedrive.returns_project_activities

Full name

pipedrive.pipedrive_get_project_activities

Returns project groups Returns all active groups under a specific project.

Lua path

app.integrations.pipedrive.returns_project_groups

Full name

pipedrive.pipedrive_get_project_groups

Returns project plan Returns information about items in a project plan. Items consists of tasks and activities and are linked to specific project phase and group.

Lua path

app.integrations.pipedrive.returns_project_plan

Full name

pipedrive.pipedrive_get_project_plan

Returns project tasks Returns tasks linked to a specific project.

Lua path

app.integrations.pipedrive.returns_project_tasks

Full name

pipedrive.pipedrive_get_project_tasks

Get details of a template Returns the details of a specific project template.

Lua path

app.integrations.pipedrive.get_details_template

Full name

pipedrive.pipedrive_get_project_template

Get all project templates Returns all not deleted project templates. This is a cursor-paginated endpoint. For more information, please refer to our documentation on <a href="https://pipedrive.readme.io/docs/core-api-concepts-pagination" target="_blank" rel="noopener noreferrer">pagination</a>.

Lua path

app.integrations.pipedrive.get_all_project_templates

Full name

pipedrive.pipedrive_get_project_templates

Get all projects Returns all projects. This is a cursor-paginated endpoint. For more information, please refer to our documentation on <a href="https://pipedrive.readme.io/docs/core-api-concepts-pagination" target="_blank" rel="noopener noreferrer">pagination</a>.

Lua path

app.integrations.pipedrive.get_all_projects

Full name

pipedrive.pipedrive_get_projects

Get details of a board Returns the details of a specific project board.

Lua path

app.integrations.pipedrive.get_details_board

Full name

pipedrive.pipedrive_get_projects_board

Get all project boards Returns all projects boards that are not deleted.

Lua path

app.integrations.pipedrive.get_all_project_boards

Full name

pipedrive.pipedrive_get_projects_boards

Get details of a phase Returns the details of a specific project phase.

Lua path

app.integrations.pipedrive.get_details_phase

Full name

pipedrive.pipedrive_get_projects_phase

Get project phases Returns all active project phases under a specific board.

Lua path

app.integrations.pipedrive.get_project_phases

Full name

pipedrive.pipedrive_get_projects_phases

Get recents Returns data about all recent changes occurred after the given timestamp.

Lua path

app.integrations.pipedrive.get_recents

Full name

pipedrive.pipedrive_get_recents

Get one role Returns the details of a specific role.

Lua path

app.integrations.pipedrive.get_one_role

Full name

pipedrive.pipedrive_get_role

List role assignments Returns all users assigned to a role.

Lua path

app.integrations.pipedrive.list_role_assignments

Full name

pipedrive.pipedrive_get_role_assignments

List pipeline visibility for a role Returns the list of either visible or hidden pipeline IDs for a specific role. For more information on pipeline visibility, please refer to the <a href="https://support.pipedrive.com/en/article/visibility-groups" target="_blank" rel="noopener noreferrer">Visibility groups article</a>.

Lua path

app.integrations.pipedrive.list_pipeline_visibility_role

Full name

pipedrive.pipedrive_get_role_pipelines

List role settings Returns the visibility settings of a specific role.

Lua path

app.integrations.pipedrive.list_role_settings

Full name

pipedrive.pipedrive_get_role_settings

Get all roles Returns all the roles within the company.

Lua path

app.integrations.pipedrive.get_all_roles

Full name

pipedrive.pipedrive_get_roles

Get deals in a stage Lists deals in a specific stage. If no parameters are provided open deals owned by the authorized user will be returned. <br>This endpoint has been deprecated. Please use <a href="https://developers.pipedrive.com/docs/api/v1/Deals#getDeals" target="_blank" rel="noopener noreferrer">GET /api/v2/deals?stage_id={id}</a> instead.

Lua path

app.integrations.pipedrive.get_deals_stage

Full name

pipedrive.pipedrive_get_stage_deals

Get details of a task Returns the details of a specific task.

Lua path

app.integrations.pipedrive.get_details_task

Full name

pipedrive.pipedrive_get_task

Get all tasks Returns all tasks. This is a cursor-paginated endpoint. For more information, please refer to our documentation on <a href="https://pipedrive.readme.io/docs/core-api-concepts-pagination" target="_blank" rel="noopener noreferrer">pagination</a>.

Lua path

app.integrations.pipedrive.get_all_tasks

Full name

pipedrive.pipedrive_get_tasks

Get a single team Returns data about a specific team.

Lua path

app.integrations.pipedrive.get_single_team

Full name

pipedrive.pipedrive_get_team

Get all users in a team Returns a list of all user IDs within a team.

Lua path

app.integrations.pipedrive.get_all_users_team

Full name

pipedrive.pipedrive_get_team_users

Get all teams Returns data about teams within the company.

Lua path

app.integrations.pipedrive.get_all_teams

Full name

pipedrive.pipedrive_get_teams

Getting the tokens After the customer has confirmed the app installation, you will need to exchange the `authorization_code` to a pair of access and refresh tokens. Using an access token, you can access the user's data through the API.

Lua path

app.integrations.pipedrive.getting_tokens

Full name

pipedrive.pipedrive_get_tokens

Get one user Returns data about a specific user within the company.

Lua path

app.integrations.pipedrive.get_one_user

Full name

pipedrive.pipedrive_get_user

Get all call logs assigned to a particular user Returns all call logs assigned to a particular user.

Lua path

app.integrations.pipedrive.get_all_call_logs_assigned_particular_user

Full name

pipedrive.pipedrive_get_user_call_logs

Get all user connections Returns data about all connections for the authorized user.

Lua path

app.integrations.pipedrive.get_all_user_connections

Full name

pipedrive.pipedrive_get_user_connections

List followers of a user Lists the followers of a specific user.

Lua path

app.integrations.pipedrive.list_followers_user

Full name

pipedrive.pipedrive_get_user_followers

List user permissions Lists aggregated permissions over all assigned permission sets for a user.

Lua path

app.integrations.pipedrive.list_user_permissions

Full name

pipedrive.pipedrive_get_user_permissions

List role assignments Lists role assignments for a user.

Lua path

app.integrations.pipedrive.list_role_assignments

Full name

pipedrive.pipedrive_get_user_role_assignments

List user role settings Lists the settings of user's assigned role.

Lua path

app.integrations.pipedrive.list_user_role_settings

Full name

pipedrive.pipedrive_get_user_role_settings

List settings of an authorized user Lists the settings of an authorized user. Example response contains a shortened list of settings.

Lua path

app.integrations.pipedrive.list_settings_authorized_user

Full name

pipedrive.pipedrive_get_user_settings

Get all teams of a user Returns data about all teams which have the specified user as a member.

Lua path

app.integrations.pipedrive.get_all_teams_user

Full name

pipedrive.pipedrive_get_user_teams

Get all users Returns data about all users within the company.

Lua path

app.integrations.pipedrive.get_all_users

Full name

pipedrive.pipedrive_get_users

Get all Webhooks Returns data about all the Webhooks of a company.

Lua path

app.integrations.pipedrive.get_all_webhooks

Full name

pipedrive.pipedrive_get_webhooks

Link a remote file to an item Links an existing remote file (`googledrive`) to the item you supply. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/adding-a-remote-file" target="_blank" rel="noopener noreferrer">adding a remote file</a>.

Lua path

app.integrations.pipedrive.link_remote_file_item

Full name

pipedrive.pipedrive_link_file_to_item

Get all deals Returns data about all not archived deals.

Lua path

app.integrations.pipedrive.get_all_deals

Full name

pipedrive.pipedrive_list_deals

Get all organizations Returns data about all organizations.

Lua path

app.integrations.pipedrive.get_all_organizations

Full name

pipedrive.pipedrive_list_organizations

Get all persons Returns data about all persons. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.

Lua path

app.integrations.pipedrive.get_all_persons

Full name

pipedrive.pipedrive_list_persons

Get all pipelines Returns data about all pipelines.

Lua path

app.integrations.pipedrive.get_all_pipelines

Full name

pipedrive.pipedrive_list_pipelines

Get all stages Returns data about all stages.

Lua path

app.integrations.pipedrive.get_all_stages

Full name

pipedrive.pipedrive_list_stages

Merge two deals Merges a deal with another deal. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/merging-two-deals" target="_blank" rel="noopener noreferrer">merging two deals</a>.

Lua path

app.integrations.pipedrive.merge_two_deals

Full name

pipedrive.pipedrive_merge_deals

Merge two organizations Merges an organization with another organization. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/merging-two-organizations" target="_blank" rel="noopener noreferrer">merging two organizations</a>.

Lua path

app.integrations.pipedrive.merge_two_organizations

Full name

pipedrive.pipedrive_merge_organizations

Merge two persons Merges a person with another person. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/merging-two-persons" target="_blank" rel="noopener noreferrer">merging two persons</a>.

Lua path

app.integrations.pipedrive.merge_two_persons

Full name

pipedrive.pipedrive_merge_persons

Update activity in project plan Updates an activity phase or group in a project.

Lua path

app.integrations.pipedrive.update_activity_project_plan

Full name

pipedrive.pipedrive_put_project_plan_activity

Update task in project plan Updates a task phase or group in a project.

Lua path

app.integrations.pipedrive.update_task_project_plan

Full name

pipedrive.pipedrive_put_project_plan_task

Receives an incoming message Adds a message to a conversation. To use the endpoint, you need to have **Messengers integration** OAuth scope enabled and the Messaging manifest ready for the [Messaging app extension](https://pipedrive.readme.io/docs/messaging-app-extension).

Lua path

app.integrations.pipedrive.receives_incoming_message

Full name

pipedrive.pipedrive_receive_message

Refreshing the tokens The `access_token` has a lifetime. After a period of time, which was returned to you in `expires_in` JSON property, the `access_token` will be invalid, and you can no longer use it to get data from our API. To refresh the `access_token`, you must use the `refresh_token`.

Lua path

app.integrations.pipedrive.refreshing_tokens

Full name

pipedrive.pipedrive_refresh_tokens

Link a user with the installed video call integration A video calling provider must call this endpoint after a user has installed the video calling app so that the new user's information is sent.

Lua path

app.integrations.pipedrive.link_user_with_installed_video_call_integration

Full name

pipedrive.pipedrive_save_user_provider_link

Search leads Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href="https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.

Lua path

app.integrations.pipedrive.search_leads

Full name

pipedrive.pipedrive_search_leads

Search organizations Searches all organizations by name, address, notes and/or custom fields. This endpoint is a wrapper of <a href="https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem">/v1/itemSearch</a> with a narrower OAuth scope.

Lua path

app.integrations.pipedrive.search_organizations

Full name

pipedrive.pipedrive_search_organizations

Search persons Searches all persons by name, email, phone, notes and/or custom fields. This endpoint is a wrapper of <a href="https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem">/v1/itemSearch</a> with a narrower OAuth scope. Found persons can be filtered by organization ID.

Lua path

app.integrations.pipedrive.search_persons

Full name

pipedrive.pipedrive_search_persons

Update an activity type Updates an activity type.

Lua path

app.integrations.pipedrive.update_activity_type

Full name

pipedrive.pipedrive_update_activity_type

Update a comment related to a note Updates a comment related to a note.

Lua path

app.integrations.pipedrive.update_comment_related_note

Full name

pipedrive.pipedrive_update_comment_for_note

Update a deal Updates the properties of a deal.

Lua path

app.integrations.pipedrive.update_deal

Full name

pipedrive.pipedrive_update_deal

Update a deal field Updates a deal field. For more information, see the tutorial for <a href=" https://pipedrive.readme.io/docs/updating-custom-field-value " target="_blank" rel="noopener noreferrer">updating custom fields' values</a>.

Lua path

app.integrations.pipedrive.update_deal_field

Full name

pipedrive.pipedrive_update_deal_field

Update file details Updates the properties of a file.

Lua path

app.integrations.pipedrive.update_file_details

Full name

pipedrive.pipedrive_update_file

Update filter Updates an existing filter.

Lua path

app.integrations.pipedrive.update_filter

Full name

pipedrive.pipedrive_update_filter

Update existing goal Updates an existing goal.

Lua path

app.integrations.pipedrive.update_existing_goal

Full name

pipedrive.pipedrive_update_goal

Update a lead Updates one or more properties of a lead. Only properties included in the request will be updated. Send `null` to unset a property (applicable for example for `value`, `person_id` or `organization_id`). If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields' structure from deals. See an example given in the <a href="https://pipedrive.readme.io/docs/updating-custom-field-value" target="_blank" rel="noopener noreferrer">updating custom fields' values tutorial</a>.

Lua path

app.integrations.pipedrive.update_lead

Full name

pipedrive.pipedrive_update_lead

Update a lead label Updates one or more properties of a lead label. Only properties included in the request will be updated.

Lua path

app.integrations.pipedrive.update_lead_label

Full name

pipedrive.pipedrive_update_lead_label

Update mail thread details Updates the properties of a mail thread.

Lua path

app.integrations.pipedrive.update_mail_thread_details

Full name

pipedrive.pipedrive_update_mail_thread_details

Update a note Updates a note.

Lua path

app.integrations.pipedrive.update_note

Full name

pipedrive.pipedrive_update_note

Update a organization Updates the properties of a organization.

Lua path

app.integrations.pipedrive.update_organization

Full name

pipedrive.pipedrive_update_organization

Update an organization field Updates an organization field. For more information, see the tutorial for <a href=" https://pipedrive.readme.io/docs/updating-custom-field-value " target="_blank" rel="noopener noreferrer">updating custom fields' values</a>.

Lua path

app.integrations.pipedrive.update_organization_field

Full name

pipedrive.pipedrive_update_organization_field

Update an organization relationship Updates and returns an organization relationship.

Lua path

app.integrations.pipedrive.update_organization_relationship

Full name

pipedrive.pipedrive_update_organization_relationship

Update a person Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.

Lua path

app.integrations.pipedrive.update_person

Full name

pipedrive.pipedrive_update_person

Update a person field Updates a person field. For more information, see the tutorial for <a href=" https://pipedrive.readme.io/docs/updating-custom-field-value " target="_blank" rel="noopener noreferrer">updating custom fields' values</a>.

Lua path

app.integrations.pipedrive.update_person_field

Full name

pipedrive.pipedrive_update_person_field

Update a product field Updates a product field. For more information, see the tutorial for <a href=" https://pipedrive.readme.io/docs/updating-custom-field-value " target="_blank" rel="noopener noreferrer">updating custom fields' values</a>.

Lua path

app.integrations.pipedrive.update_product_field

Full name

pipedrive.pipedrive_update_product_field

Update a project Updates a project.

Lua path

app.integrations.pipedrive.update_project

Full name

pipedrive.pipedrive_update_project

Update role details Updates the parent role and/or the name of a specific role.

Lua path

app.integrations.pipedrive.update_role_details

Full name

pipedrive.pipedrive_update_role

Update pipeline visibility for a role Updates the specified pipelines to be visible and/or hidden for a specific role. For more information on pipeline visibility, please refer to the <a href="https://support.pipedrive.com/en/article/visibility-groups" target="_blank" rel="noopener noreferrer">Visibility groups article</a>.

Lua path

app.integrations.pipedrive.update_pipeline_visibility_role

Full name

pipedrive.pipedrive_update_role_pipelines

Update a task Updates a task.

Lua path

app.integrations.pipedrive.update_task

Full name

pipedrive.pipedrive_update_task

Update a team Updates an existing team and returns the updated object.

Lua path

app.integrations.pipedrive.update_team

Full name

pipedrive.pipedrive_update_team

Update user details Updates the properties of a user. Currently, only `active_flag` can be updated.

Lua path

app.integrations.pipedrive.update_user_details

Full name

pipedrive.pipedrive_update_user

Add a new activity Adds a new activity.

Lua path

app.integrations.pipedrive.add_new_activity

Full name

pipedrive.pipedrive_v2_add_activity

Create one deal field Creates a new deal custom field.

Lua path

app.integrations.pipedrive.create_one_deal_field

Full name

pipedrive.pipedrive_v2_add_deal_field

Add deal field options in bulk Adds new options to a deal custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.

Lua path

app.integrations.pipedrive.add_deal_field_options_bulk

Full name

pipedrive.pipedrive_v2_add_deal_field_options

Add a follower to a deal Adds a user as a follower to the deal.

Lua path

app.integrations.pipedrive.add_follower_deal

Full name

pipedrive.pipedrive_v2_add_deal_follower

Add a product to a deal Adds a product to a deal, creating a new item called a deal-product.

Lua path

app.integrations.pipedrive.add_product_deal

Full name

pipedrive.pipedrive_v2_add_deal_product

Add multiple products to a deal Adds multiple products to a deal in a single request. Maximum of 100 products allowed per request.

Lua path

app.integrations.pipedrive.add_multiple_products_deal

Full name

pipedrive.pipedrive_v2_add_many_deal_products

Create one organization field Creates a new organization custom field.

Lua path

app.integrations.pipedrive.create_one_organization_field

Full name

pipedrive.pipedrive_v2_add_organization_field

Add organization field options in bulk Adds new options to an organization custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.

Lua path

app.integrations.pipedrive.add_organization_field_options_bulk

Full name

pipedrive.pipedrive_v2_add_organization_field_options

Add a follower to an organization Adds a user as a follower to the organization.

Lua path

app.integrations.pipedrive.add_follower_organization

Full name

pipedrive.pipedrive_v2_add_organization_follower

Create one person field Creates a new person custom field.

Lua path

app.integrations.pipedrive.create_one_person_field

Full name

pipedrive.pipedrive_v2_add_person_field

Add person field options in bulk Adds new options to a person custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.

Lua path

app.integrations.pipedrive.add_person_field_options_bulk

Full name

pipedrive.pipedrive_v2_add_person_field_options

Add a follower to a person Adds a user as a follower to the person.

Lua path

app.integrations.pipedrive.add_follower_person

Full name

pipedrive.pipedrive_v2_add_person_follower

Add a new pipeline Adds a new pipeline.

Lua path

app.integrations.pipedrive.add_new_pipeline

Full name

pipedrive.pipedrive_v2_add_pipeline

Add a product Adds a new product to the Products inventory. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/adding-a-product" target="_blank" rel="noopener noreferrer">adding a product</a>.

Lua path

app.integrations.pipedrive.add_product

Full name

pipedrive.pipedrive_v2_add_product

Create one product field Creates a new product custom field.

Lua path

app.integrations.pipedrive.create_one_product_field

Full name

pipedrive.pipedrive_v2_add_product_field

Add product field options in bulk Adds new options to a product custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.

Lua path

app.integrations.pipedrive.add_product_field_options_bulk

Full name

pipedrive.pipedrive_v2_add_product_field_options

Add a follower to a product Adds a user as a follower to the product.

Lua path

app.integrations.pipedrive.add_follower_product

Full name

pipedrive.pipedrive_v2_add_product_follower

Add a product variation Adds a new product variation.

Lua path

app.integrations.pipedrive.add_product_variation

Full name

pipedrive.pipedrive_v2_add_product_variation

Add a project Adds a new project. Custom fields should be wrapped in the `custom_fields` object.

Lua path

app.integrations.pipedrive.add_project

Full name

pipedrive.pipedrive_v2_add_project

Add a project board Adds a new project board.

Lua path

app.integrations.pipedrive.add_project_board

Full name

pipedrive.pipedrive_v2_add_project_board

Create one project field Creates a new project custom field.

Lua path

app.integrations.pipedrive.create_one_project_field

Full name

pipedrive.pipedrive_v2_add_project_field

Add project field options in bulk Adds new options to a project custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.

Lua path

app.integrations.pipedrive.add_project_field_options_bulk

Full name

pipedrive.pipedrive_v2_add_project_field_options

Add a project phase Adds a new project phase to a board.

Lua path

app.integrations.pipedrive.add_project_phase

Full name

pipedrive.pipedrive_v2_add_project_phase

Add a new stage Adds a new stage, returns the ID upon success.

Lua path

app.integrations.pipedrive.add_new_stage

Full name

pipedrive.pipedrive_v2_add_stage

Add a task Adds a new task.

Lua path

app.integrations.pipedrive.add_task

Full name

pipedrive.pipedrive_v2_add_task

Archive a project Archives a project.

Lua path

app.integrations.pipedrive.archive_project

Full name

pipedrive.pipedrive_v2_archive_project

Convert a deal to a lead Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href="https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.

Lua path

app.integrations.pipedrive.convert_deal_lead

Full name

pipedrive.pipedrive_v2_convert_deal_to_lead

Convert a lead to a deal Initiates a conversion of a lead to a deal. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. If the conversion is successful, the lead is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href="https://developers.pipedrive.com/docs/api/v1/Leads#getLeadConversionStatus">/api/v2/leads/{lead_id}/convert/status/{conversion_id}</a> endpoint.

Lua path

app.integrations.pipedrive.convert_lead_deal

Full name

pipedrive.pipedrive_v2_convert_lead_to_deal

Delete an activity Marks an activity as deleted. After 30 days, the activity will be permanently deleted.

Lua path

app.integrations.pipedrive.delete_activity

Full name

pipedrive.pipedrive_v2_delete_activity

Delete a discount from a deal Removes a discount from a deal, changing the deal value if the deal has one-time products attached.

Lua path

app.integrations.pipedrive.delete_discount_from_deal

Full name

pipedrive.pipedrive_v2_delete_additional_discount

Delete a deal Marks a deal as deleted. After 30 days, the deal will be permanently deleted.

Lua path

app.integrations.pipedrive.delete_deal

Full name

pipedrive.pipedrive_v2_delete_deal

Delete one deal field Marks a custom field as deleted.

Lua path

app.integrations.pipedrive.delete_one_deal_field

Full name

pipedrive.pipedrive_v2_delete_deal_field

Delete deal field options in bulk Removes existing options from a deal custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options.

Lua path

app.integrations.pipedrive.delete_deal_field_options_bulk

Full name

pipedrive.pipedrive_v2_delete_deal_field_options

Delete a follower from a deal Deletes a user follower from the deal.

Lua path

app.integrations.pipedrive.delete_follower_from_deal

Full name

pipedrive.pipedrive_v2_delete_deal_follower

Delete an attached product from a deal Deletes a product attachment from a deal, using the `product_attachment_id`.

Lua path

app.integrations.pipedrive.delete_attached_product_from_deal

Full name

pipedrive.pipedrive_v2_delete_deal_product

Delete an installment from a deal Removes an installment from a deal. Only available in Growth and above plans.

Lua path

app.integrations.pipedrive.delete_installment_from_deal

Full name

pipedrive.pipedrive_v2_delete_installment

Delete many products from a deal Deletes multiple products from a deal. If no product IDs are specified, up to 100 products will be removed from the deal. A maximum of 100 product IDs can be provided per request.

Lua path

app.integrations.pipedrive.delete_many_products_from_deal

Full name

pipedrive.pipedrive_v2_delete_many_deal_products

Delete a organization Marks a organization as deleted. After 30 days, the organization will be permanently deleted.

Lua path

app.integrations.pipedrive.delete_organization

Full name

pipedrive.pipedrive_v2_delete_organization

Delete one organization field Marks a custom field as deleted.

Lua path

app.integrations.pipedrive.delete_one_organization_field

Full name

pipedrive.pipedrive_v2_delete_organization_field

Delete organization field options in bulk Removes existing options from an organization custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options.

Lua path

app.integrations.pipedrive.delete_organization_field_options_bulk

Full name

pipedrive.pipedrive_v2_delete_organization_field_options

Delete a follower from an organization Deletes a user follower from the organization.

Lua path

app.integrations.pipedrive.delete_follower_from_organization

Full name

pipedrive.pipedrive_v2_delete_organization_follower

Delete a person Marks a person as deleted. After 30 days, the person will be permanently deleted.

Lua path

app.integrations.pipedrive.delete_person

Full name

pipedrive.pipedrive_v2_delete_person

Delete one person field Marks a custom field as deleted.

Lua path

app.integrations.pipedrive.delete_one_person_field

Full name

pipedrive.pipedrive_v2_delete_person_field

Delete person field options in bulk Removes existing options from a person custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options.

Lua path

app.integrations.pipedrive.delete_person_field_options_bulk

Full name

pipedrive.pipedrive_v2_delete_person_field_options

Delete a follower from a person Deletes a user follower from the person.

Lua path

app.integrations.pipedrive.delete_follower_from_person

Full name

pipedrive.pipedrive_v2_delete_person_follower

Delete a pipeline Marks a pipeline as deleted.

Lua path

app.integrations.pipedrive.delete_pipeline

Full name

pipedrive.pipedrive_v2_delete_pipeline

Delete a product Marks a product as deleted. After 30 days, the product will be permanently deleted.

Lua path

app.integrations.pipedrive.delete_product

Full name

pipedrive.pipedrive_v2_delete_product

Delete one product field Marks a custom field as deleted.

Lua path

app.integrations.pipedrive.delete_one_product_field

Full name

pipedrive.pipedrive_v2_delete_product_field

Delete product field options in bulk Removes existing options from a product custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options.

Lua path

app.integrations.pipedrive.delete_product_field_options_bulk

Full name

pipedrive.pipedrive_v2_delete_product_field_options

Delete a follower from a product Deletes a user follower from the product.

Lua path

app.integrations.pipedrive.delete_follower_from_product

Full name

pipedrive.pipedrive_v2_delete_product_follower

Delete an image of a product Deletes the image of a product.

Lua path

app.integrations.pipedrive.delete_image_product

Full name

pipedrive.pipedrive_v2_delete_product_image

Delete a product variation Deletes a product variation.

Lua path

app.integrations.pipedrive.delete_product_variation

Full name

pipedrive.pipedrive_v2_delete_product_variation

Delete a project Marks a project as deleted.

Lua path

app.integrations.pipedrive.delete_project

Full name

pipedrive.pipedrive_v2_delete_project

Delete a project board Marks a project board as deleted.

Lua path

app.integrations.pipedrive.delete_project_board

Full name

pipedrive.pipedrive_v2_delete_project_board

Delete one project field Marks a custom field as deleted.

Lua path

app.integrations.pipedrive.delete_one_project_field

Full name

pipedrive.pipedrive_v2_delete_project_field

Delete project field options in bulk Removes existing options from a project custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options.

Lua path

app.integrations.pipedrive.delete_project_field_options_bulk

Full name

pipedrive.pipedrive_v2_delete_project_field_options

Delete a project phase Marks a project phase as deleted.

Lua path

app.integrations.pipedrive.delete_project_phase

Full name

pipedrive.pipedrive_v2_delete_project_phase

Delete a stage Marks a stage as deleted.

Lua path

app.integrations.pipedrive.delete_stage

Full name

pipedrive.pipedrive_v2_delete_stage

Delete a task Marks a task as deleted. If the task has subtasks, those will also be deleted.

Lua path

app.integrations.pipedrive.delete_task

Full name

pipedrive.pipedrive_v2_delete_task