Using Pipedrive?

Activities

• GET

  Add an activity

  Add an activity

  Parameters:

  • Subject of the activity, String
  • Whether the activity is done or not, Boolean
  • Type of the activity, String
  • Due date and time of the activity, Integer
  • Duration of the activity, Integer
  • ID of the user, Integer
  • ID of the deal, Integer
  • ID of the person, Integer
  • ID of the organization, Integer
  • Note of the activity, String
  • List of multiple persons, String
  • Your Pipedrive ID, Integer

  Returns:

  • model, Object
• GET

  Delete an activity

  Delete an activity

  Parameters:

  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Delete multiple activities

  Marks multiple activities as deleted

  Parameters:

  • Ids of essence, String
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Edit an activity

  Edit an activity

  Parameters:

  • Subject of the activity, String
  • Whether the activity is done or not, Boolean
  • Type of the activity, String
  • Due date and time of the activity, Integer
  • Duration of the activity, Integer
  • ID of the user, Integer
  • ID of the deal, Integer
  • ID of the person, Integer
  • ID of the organization, Integer
  • Note of the activity, String
  • List of multiple persons, String
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • model, Object
• GET

  Get all activities

  Returns all activities assigned to a particular user

  Parameters:

  • ID of the user who's activities to fetch, Integer
  • ID of the filter to use, Integer
  • Type of the activity, String
  • Pagination start, Integer
  • Items shown per page, Integer
  • Date in timestamp format, Integer
  • Date in timestamp format, Integer
  • Whether the activity is done or not, Boolean
  • Your Pipedrive ID, Integer

  Returns:

  • activitiesList, Array [Object]
• GET

  Get details of an activity

  Get details of an activity

  Parameters:

  • ID of the activity, Integer
  • ID of the your pipedrive user, Integer

  Returns:

  • model, Object

ActivityTypes

• GET

  Add new activity type

  Adds a new activity type, returns the ID, the key_string and the order number of the newly added activity type upon success.

  Parameters:

  • Name of the activity type, String
  • Icon graphic , Integer
  • A designated color, String
  • Your Pipedrive ID, Integer

  Returns:

  • activityTypeList, Array [Object]
• GET

  Delete an activity type

  Marks an activity type as deleted.

  Parameters:

  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Delete multiple activity types in bulk

  Marks multiple activity types as deleted

  Parameters:

  • Ids of essence, String
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Edit activity type

  Updates an activity type.

  Parameters:

  • Subject of the activity, String
  • Whether the activity is done or not, Boolean
  • Type of the activity, String
  • Due date and time of the activity, Integer
  • Duration of the activity, Integer
  • ID of the user, Integer
  • ID of the deal, Integer
  • ID of the person, Integer
  • ID of the organization, Integer
  • Note of the activity, String
  • List of multiple persons, String
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • activityTypeList, Array [Object]
• GET

  Get all activity types

  Returns all activity types

  Parameters:

  • ID of the activity, Integer

  Returns:

  • activityTypeList, Array [Object]

Authorization

• GET

  Get all authorizations for a user

  Returns all authorizations for a particular user. Authorization objects contain the API tokens the user has with different company accounts in Pipedrive. These can be fetched without an API token but using the email and password of the user

  Parameters:

  • Email of the user, String
  • Password of the user, String

  Returns:

  • userId, Integer
  • companyId, Integer
  • apiToken, String
  • addTime, String
  • company, Object

Currencies

• GET

  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.

  Parameters:

  • Currencies name or code, String
  • Your Pipedrive ID, Integer

  Returns:

  • currenciesList, Array [Object]

Deals

• GET

  Add a deal

  Adds a new deal. 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. To determine which custom fields exists, fetch the dealFields and look for 'key' values

  Parameters:

  • Deal title, String
  • Value of the deal, String
  • Currency of the deal, String
  • ID of the user, Integer
  • ID of the person, Integer
  • ID of the organization, Integer
  • ID of the stag, Integer
  • Deal status, Integer
  • Why the deal was lost?(if lost), String
  • Creation date, Integer
  • Visibility of the deal, Integer
  • Custom fields, Array [Object]
  • Your Pipedrive ID, Integer

  Returns:

  • model, Object
• GET

  Add a follower to a deal

  Adds a follower to a deal.

  Parameters:

  • ID of the user, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • userId, Integer
  • id, Integer
  • dealId, Integer
  • addTime, String
• GET

  Add a participant to a deal

  Add a participant to a deal

  Parameters:

  • ID of the person, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • personId, Object
  • addTime, String
  • activeFlag, Boolean
  • relatedItemData, Object
  • person, Object
  • addedByUserId, Object
  • relatedItemType, String
  • relatedItemId, Integer
• GET

  Add a product to the deal

  Add a product to the deal, eventually creating a new item called a deal-product

  Parameters:

  • ID of the product, Integer
  • Product price, Integer
  • Products quantity, Integer
  • Discount, Integer
  • Duration of the product, Integer
  • ID of the product variation, Integer
  • Any textual comment, String
  • Product is enabled on the deal or not, Boolean
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • dealId, Integer
  • orderNr, Integer
  • productId, Integer
  • productVariationId, String
  • itemPrice, Integer
  • discountPercentage, Integer
  • duration, Integer
  • sumNoDiscount, Integer
  • sum, Integer
  • currency, String
  • enabledFlag, Boolean
  • addTime, String
  • lastEdit, String
  • comments, Object
  • activeFlag, Boolean
  • name, String
  • sumFormatted, String
  • quantityFormatted, String
  • quantity, Integer
  • product, Object
  • customFields, Array [Object]
• GET

  Add multiple products to the deal

  Add multiple products to the deal, eventually creating a new items called a deal-product

  Parameters:

  • ID of the deal, Integer
  • Products, Array [Object]
  • Your Pipedrive ID, Integer

  Returns:

  • results, Array [Object]
• GET

  Delete a deal

  Marks a deal as deleted.

  Parameters:

  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Delete a follower from a deal

  Delete a follower from a deal

  Parameters:

  • ID of the follower, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Delete a participant from a deal

  Delete a participant from a deal

  Parameters:

  • ID of the deal participant, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Delete an attached product from a deal

  Delete an attached product from a deal

  Parameters:

  • Product attachment ID, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Delete multiple deals in bulk

  Marks multiple deals as deleted.

  Parameters:

  • Ids of essence, String
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Duplicate deal

  Duplicate deal

  Parameters:

  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • creatorUserId, Integer
  • userId, Integer
  • personId, Integer
  • orgId, Integer
  • stageId, Integer
  • title, String
  • value, Integer
  • currency, String
  • addTime, String
  • updateTime, String
  • stageChangeTime, String
  • active, Boolean
  • deleted, Boolean
  • status, String
  • nextActivityDate, String
  • nextActivityTime, String
  • nextActivityId, Integer
  • lastActivityId, Integer
  • lastActivityDate, String
  • lostReason, String
  • visibleTo, String
  • closeTime, String
  • pipelineId, Integer
  • wonTime, String
  • firstWonTime, String
  • lostTime, String
  • productsCount, Integer
  • filesCount, Integer
  • notesCount, Integer
  • followersCount, Integer
  • emailMessagesCount, Integer
  • activitiesCount, Integer
  • doneActivitiesCount, Integer
  • undoneActivitiesCount, Integer
  • referenceActivitiesCount, Integer
  • participantsCount, Integer
  • expectedCloseDate, String
  • lastIncomingMailTime, String
  • lastOutgoingMailTime, String
  • stageOrderNr, Integer
  • personName, String
  • orgName, String
  • nextActivitySubject, String
  • nextActivityType, String
  • nextActivityDuration, String
  • nextActivityNote, String
  • formattedValue, String
  • rottenTime, String
  • weightedValue, Integer
  • formattedWeightedValue, String
  • ownerName, String
  • ccEmail, String
  • orgHidden, Boolean
  • personHidden, Boolean
  • customFields, Array [Object]
• GET

  Find deals by name

  Searches all deals by their title.

  Parameters:

  • Search term to look for, String
  • ID of the associated person, Integer
  • ID of the associated organization, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • dealsList, Array [Object]
• GET

  Get all deals

  Returns all deals

  Parameters:

  • ID of the user, Integer
  • ID of the filter, Integer
  • Deals with specific stage, Integer
  • Deals with specific status, Integer
  • Pagination start, Integer
  • Items shown per page, Integer
  • Field names and sorting, String
  • Owned by you, Boolean
  • Your Pipedrive ID, Integer

  Returns:

  • dealsList, Array [Object]
• GET

  Get deals timeline

  Returns open and won deals, grouped by 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.

  Parameters:

  • Start date, Integer
  • Type of interval, Integer
  • Number of given intervals, Integer
  • Name of the date field, String
  • Id of user, Integer
  • ID of pipeline, Integer
  • Id of filter, Integer
  • Exclude deals, Boolean
  • Totals convert currency, String
  • Your Pipedrive ID, Integer

  Returns:

  • dealsTimelines, Array [Object]
• GET

  Get details of a deal

  Returns details of a specific deal. Note that this also returns some additional fields which are not present when asking for all deals – such as deal age and stay in pipeline stages. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the 'key' value of dealFields.

  Parameters:

  • ID of the deal, Integer
  • ID of the your pipedrive user, Integer

  Returns:

  • model, Object
• GET

  List activities associated with a deal

  Lists activities associated with a deal.

  Parameters:

  • Pagination start, Integer
  • Items shown per page, Integer
  • Done or undone, Boolean
  • A comma-separated string of activity IDs, String
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • activitiesList, Array [Object]
• GET

  List files attached to a deal

  List files attached to a deal

  Parameters:

  • Include deleted files, Boolean
  • Field names and sorting mode, String
  • Pagination start, Integer
  • Items shown per page, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • filesList, Array [Object]
• GET

  List followers of a deal

  Lists the followers of a deal.

  Parameters:

  • ID of the deal, Integer
  • ID of the activity, Integer

  Returns:

  • followersList, Array [Object]
• GET

  List mail messages associated with a deal

  Lists mail messages associated with a deal.

  Parameters:

  • Pagination start, Integer
  • Items shown per page, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • messages, Array [Object]
• GET

  List participants of a deal

  Lists participants associated with a deal.

  Parameters:

  • ID of the deal, Integer
  • ID of the your pipedrive user, Integer
  • Pagination start, Integer
  • Items shown per page, Integer

  Returns:

  • participantsList, Array [Object]
• GET

  List permitted users

  List users permitted to access a deal

  Parameters:

  • Access level, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • usersList, Array [Integer]
• GET

  List products attached to a deal

  Lists products attached to a deal.

  Parameters:

  • ID of the deal, Integer
  • ID of the your pipedrive user, Integer
  • Pagination start, Integer
  • Items shown per page, Integer
  • Include product data, Boolean

  Returns:

  • products, Array [Object]
• GET

  List updates about a deal

  Lists updates about a deal.

  Parameters:

  • Pagination start, Integer
  • Items shown per page, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • updatesList, Array [Object]
• GET

  Merge two deals

  Merges a deal with another deal.

  Parameters:

  • Merge with id, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • mergeWhatId, Integer
  • id, Integer
  • creatorUserId, Integer
  • userId, Integer
  • personId, Integer
  • orgId, Integer
  • stageId, Integer
  • title, String
  • value, Integer
  • currency, String
  • addTime, String
  • updateTime, String
  • stageChangeTime, String
  • active, Boolean
  • deleted, Boolean
  • status, String
  • nextActivityDate, String
  • nextActivityTime, String
  • nextActivityId, Integer
  • lastActivityId, Integer
  • lastActivityDate, String
  • lostReason, String
  • visibleTo, String
  • closeTime, String
  • pipelineId, Integer
  • wonTime, String
  • firstWonTime, String
  • lostTime, String
  • productsCount, Integer
  • filesCount, Integer
  • notesCount, Integer
  • followersCount, Integer
  • emailMessagesCount, Integer
  • activitiesCount, Integer
  • doneActivitiesCount, Integer
  • undoneActivitiesCount, Integer
  • referenceActivitiesCount, Integer
  • participantsCount, Integer
  • expectedCloseDate, String
  • lastIncomingMailTime, String
  • lastOutgoingMailTime, String
  • stageOrderNr, Integer
  • personName, String
  • orgName, String
  • nextActivitySubject, String
  • nextActivityType, String
  • nextActivityDuration, String
  • nextActivityNote, String
  • formattedValue, String
  • rottenTime, String
  • weightedValue, Integer
  • formattedWeightedValue, String
  • ownerName, String
  • ccEmail, String
  • orgHidden, Boolean
  • personHidden, Boolean
  • customFields, Array [Object]
• GET

  Update a deal

  Updates the properties of a deal.

  Parameters:

  • Deal title, String
  • Value of the deal, String
  • Currency of the deal, String
  • ID of the user, Integer
  • ID of the person, Integer
  • ID of the organization, Integer
  • ID of the stag, Integer
  • Deal status, Integer
  • Why the deal was lost?(if lost), String
  • Creation date, Integer
  • Visibility of the deal, Integer
  • Custom fields, Array [Object]
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • model, Object
• GET

  Updates product attachment details

  Update product attachment details of the deal-product (a product already attached to a deal)

  Parameters:

  • ID of the deal-product, Integer
  • Product price, Integer
  • Products quantity, Integer
  • Discount, Integer
  • Duration of the product, Integer
  • ID of the product variation, Integer
  • Any textual comment, String
  • Product is enabled on the deal or not, Boolean
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • dealId, Integer
  • orderNr, Integer
  • productId, Integer
  • productVariationId, String
  • itemPrice, Integer
  • discountPercentage, Integer
  • duration, Integer
  • sumNoDiscount, Integer
  • sum, Integer
  • currency, String
  • enabledFlag, Boolean
  • addTime, String
  • lastEdit, String
  • comments, Object
  • activeFlag, Boolean
  • name, String
  • sumFormatted, String
  • quantityFormatted, String
  • quantity, Integer
  • product, Object
  • customFields, Array [Object]

Fields

• GET

  Add a new organization field

  Adds a new organization field

  Parameters:

  • Name of the field, String
  • Type of the field, Integer
  • Field options, String
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • key, String
  • name, String
  • orderNr, Integer
  • picklistData, Object
  • fieldType, String
  • addTime, String
  • updateTime, String
  • activeFlag, Boolean
  • editFlag, Boolean
  • indexVisibleFlag, Boolean
  • detailsVisibleFlag, Boolean
  • addVisibleFlag, Boolean
  • importantFlag, Boolean
  • bulkEditAllowed, Boolean
  • useField, String
  • link, String
  • mandatoryFlag, Object
  • displayField, String
  • options, Array [Object]
  • isSubfield, Boolean
  • autocomplete, String
  • visibleInExportsFlag, Boolean
• GET

  Add a new person field

  Adds a new person field

  Parameters:

  • Name of the field, String
  • Type of the field, Integer
  • Field options, String
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • key, String
  • name, String
  • orderNr, Integer
  • picklistData, Object
  • fieldType, String
  • addTime, String
  • updateTime, String
  • activeFlag, Boolean
  • editFlag, Boolean
  • indexVisibleFlag, Boolean
  • detailsVisibleFlag, Boolean
  • addVisibleFlag, Boolean
  • importantFlag, Boolean
  • bulkEditAllowed, Boolean
  • useField, String
  • link, String
  • mandatoryFlag, Object
  • displayField, String
  • options, Array [Object]
  • isSubfield, Boolean
  • autocomplete, String
  • visibleInExportsFlag, Boolean
• GET

  Delete a person field

  Marks a field as deleted.

  Parameters:

  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Delete an organization field

  Marks a field as deleted.

  Parameters:

  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Delete multiple organization fields in bulk

  Delete multiple organization fields

  Parameters:

  • Ids of essence, String
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Delete multiple person fields in bulk

  Marks multiple fields as deleted.

  Parameters:

  • Ids of essence, String
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Delete multiple product fields in bulk

  Marks multiple fields as deleted

  Parameters:

  • Ids of essence, String
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Get all fields for an activity

  Return list of all fields for activity

  Parameters:

  • ID of the activity, Integer

  Returns:

  • fieldsList, Array [Object]
• GET

  Get all organization fields

  Returns data about all organization fields

  Parameters:

  • ID of the your pipedrive user, Integer

  Returns:

  • fieldsList, Array [Object]
• GET

  Get all person fields

  Returns data about all person fields

  Parameters:

  • ID of the your pipedrive user, Integer

  Returns:

  • fieldsList, Array [Object]
• GET

  Get all product fields

  Returns data about all product fields

  Parameters:

  • ID of the your pipedrive user, Integer

  Returns:

  • fieldsList, Array [Object]
• GET

  Get one organization field

  Returns data about a specific organization field.

  Parameters:

  • ID of the field to fetch., Integer
  • ID of the activity, Integer

  Returns:

  • id, Integer
  • key, String
  • name, String
  • orderNr, Integer
  • picklistData, Object
  • fieldType, String
  • addTime, String
  • updateTime, String
  • activeFlag, Boolean
  • editFlag, Boolean
  • indexVisibleFlag, Boolean
  • detailsVisibleFlag, Boolean
  • addVisibleFlag, Boolean
  • importantFlag, Boolean
  • bulkEditAllowed, Boolean
  • useField, String
  • link, String
  • mandatoryFlag, Object
  • displayField, String
  • options, Array [Object]
  • isSubfield, Boolean
  • autocomplete, String
  • visibleInExportsFlag, Boolean
• GET

  Get one person field

  Returns data about a specific person field.

  Parameters:

  • ID of the field to fetch., Integer
  • ID of the your pipedrive user, Integer

  Returns:

  • id, Integer
  • key, String
  • name, String
  • orderNr, Integer
  • picklistData, Object
  • fieldType, String
  • addTime, String
  • updateTime, String
  • activeFlag, Boolean
  • editFlag, Boolean
  • indexVisibleFlag, Boolean
  • detailsVisibleFlag, Boolean
  • addVisibleFlag, Boolean
  • importantFlag, Boolean
  • bulkEditAllowed, Boolean
  • useField, String
  • link, String
  • mandatoryFlag, Object
  • displayField, String
  • options, Array [Object]
  • isSubfield, Boolean
  • autocomplete, String
  • visibleInExportsFlag, Boolean
• GET

  Update a person field

  Updates a person field

  Parameters:

  • Name of the field, String
  • Field options, String
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • key, String
  • name, String
  • orderNr, Integer
  • picklistData, Object
  • fieldType, String
  • addTime, String
  • updateTime, String
  • activeFlag, Boolean
  • editFlag, Boolean
  • indexVisibleFlag, Boolean
  • detailsVisibleFlag, Boolean
  • addVisibleFlag, Boolean
  • importantFlag, Boolean
  • bulkEditAllowed, Boolean
  • useField, String
  • link, String
  • mandatoryFlag, Object
  • displayField, String
  • options, Array [Object]
  • isSubfield, Boolean
  • autocomplete, String
  • visibleInExportsFlag, Boolean
• GET

  Update an organization field

  Updates an organization field

  Parameters:

  • Name of the field, String
  • Field options, String
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • key, String
  • name, String
  • orderNr, Integer
  • picklistData, Object
  • fieldType, String
  • addTime, String
  • updateTime, String
  • activeFlag, Boolean
  • editFlag, Boolean
  • indexVisibleFlag, Boolean
  • detailsVisibleFlag, Boolean
  • addVisibleFlag, Boolean
  • importantFlag, Boolean
  • bulkEditAllowed, Boolean
  • useField, String
  • link, String
  • mandatoryFlag, Object
  • displayField, String
  • options, Array [Object]
  • isSubfield, Boolean
  • autocomplete, String
  • visibleInExportsFlag, Boolean

Fieleds

• GET

  Add a new deal field

  Adds a new deal field

  Parameters:

  • Name of the field, String
  • Type of the field, Integer
  • Field options, String
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • key, String
  • name, String
  • orderNr, Integer
  • picklistData, Object
  • fieldType, String
  • addTime, String
  • updateTime, String
  • activeFlag, Boolean
  • editFlag, Boolean
  • indexVisibleFlag, Boolean
  • detailsVisibleFlag, Boolean
  • addVisibleFlag, Boolean
  • importantFlag, Boolean
  • bulkEditAllowed, Boolean
  • useField, String
  • link, String
  • mandatoryFlag, Object
  • displayField, String
  • options, Array [Object]
  • isSubfield, Boolean
  • autocomplete, String
  • visibleInExportsFlag, Boolean
• GET

  Delete a deal field

  Marks a field as deleted.

  Parameters:

  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Delete multiple deal fields in bulk

  Marks multiple fields as deleted.

  Parameters:

  • Ids of essence, String
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Get all deal fields

  Returns data about all fields deals can have

  Parameters:

  • ID of the activity, Integer

  Returns:

  • fieldsList, Array [Object]
• GET

  Get all fields for a note

  Return list of all fields for note

  Parameters:

  • ID of the your pipedrive user, Integer

  Returns:

  • fieldsList, Array [Object]
• GET

  Get one deal field

  Returns data about a specific deal field.

  Parameters:

  • ID of the deal, Integer
  • ID of the activity, Integer

  Returns:

  • id, Integer
  • key, String
  • name, String
  • orderNr, Integer
  • picklistData, Object
  • fieldType, String
  • addTime, String
  • updateTime, String
  • activeFlag, Boolean
  • editFlag, Boolean
  • indexVisibleFlag, Boolean
  • detailsVisibleFlag, Boolean
  • addVisibleFlag, Boolean
  • importantFlag, Boolean
  • bulkEditAllowed, Boolean
  • useField, String
  • link, String
  • mandatoryFlag, Object
  • displayField, String
  • options, Array [Object]
  • isSubfield, Boolean
  • autocomplete, String
  • visibleInExportsFlag, Boolean
• GET

  Update a deal field

  Updates a deal field

  Parameters:

  • Name of the field, String
  • Field options, String
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • key, String
  • name, String
  • orderNr, Integer
  • picklistData, Object
  • fieldType, String
  • addTime, String
  • updateTime, String
  • activeFlag, Boolean
  • editFlag, Boolean
  • indexVisibleFlag, Boolean
  • detailsVisibleFlag, Boolean
  • addVisibleFlag, Boolean
  • importantFlag, Boolean
  • bulkEditAllowed, Boolean
  • useField, String
  • link, String
  • mandatoryFlag, Object
  • displayField, String
  • options, Array [Object]
  • isSubfield, Boolean
  • autocomplete, String
  • visibleInExportsFlag, Boolean

Files

• GET

  Add file

  Lets you upload a file, and associate it with a Deal, a Person, an Organization, an Activity or a Product.

  Parameters:

  • File url, String
  • ID of the deal to associate, Integer
  • ID of the person to associate, Integer
  • ID of the organization to associate, Integer
  • ID of the product to associate, Integer
  • ID of the activity to associate, Integer
  • ID of the note to associate, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • userId, Integer
  • dealId, Integer
  • personId, Integer
  • orgId, Integer
  • productId, Integer
  • emailMessageId, Integer
  • activityId, Integer
  • noteId, Integer
  • logId, Integer
  • addTime, String
  • updateTime, String
  • fileName, String
  • fileType, String
  • fileSize, Integer
  • activeFlag, Boolean
  • inlineFlag, Boolean
  • remoteLocation, String
  • remoteId, String
  • cid, Object
  • s3Bucket, Object
  • mailMessageId, Integer
  • dealName, String
  • personName, String
  • orgName, String
  • productName, String
  • url, String
  • name, String
  • description, String
• GET

  Create a remote file and link it to an item

  Creates a new empty file in the remote location (googledrive, etc) that will be linked to the item you supply.

  Parameters:

  • The file type, Integer
  • The title of the file, String
  • The item type, Integer
  • ID of the item to associate, Integer
  • Remote location, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • userId, Integer
  • dealId, Integer
  • personId, Integer
  • orgId, Integer
  • productId, Integer
  • emailMessageId, Integer
  • activityId, Integer
  • noteId, Integer
  • logId, Integer
  • addTime, String
  • updateTime, String
  • fileName, String
  • fileType, String
  • fileSize, Integer
  • activeFlag, Boolean
  • inlineFlag, Boolean
  • remoteLocation, String
  • remoteId, String
  • cid, Object
  • s3Bucket, Object
  • mailMessageId, Integer
  • dealName, String
  • personName, String
  • orgName, String
  • productName, String
  • url, String
  • name, String
  • description, String
• GET

  Delete a file

  Marks a file as deleted

  Parameters:

  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Download one file

  Initializes a file download

  Parameters:

  • ID of the file to download., Integer
  • ID of the your pipedrive user, Integer

  Returns:

  • downloadFileUrl, String
• GET

  Get all e-mail message threads

  Returns data about all files

  Parameters:

  • ID of the your pipedrive user, Integer
  • Pagination start, Integer
  • Items shown per page, Integer
  • Include product data, Boolean
  • Field names and sorting mode separated by comma, String

  Returns:

  • filesList, Array [Object]
• GET

  Get one file

  Returns data about all files

  Parameters:

  • ID of the file to fetch., Integer
  • ID of the your pipedrive user, Integer

  Returns:

  • id, Integer
  • userId, Integer
  • dealId, Integer
  • personId, Integer
  • orgId, Integer
  • productId, Integer
  • emailMessageId, Integer
  • activityId, Integer
  • noteId, Integer
  • logId, Integer
  • addTime, String
  • updateTime, String
  • fileName, String
  • fileType, String
  • fileSize, Integer
  • activeFlag, Boolean
  • inlineFlag, Boolean
  • remoteLocation, String
  • remoteId, String
  • cid, Object
  • s3Bucket, Object
  • mailMessageId, Integer
  • dealName, String
  • personName, String
  • orgName, String
  • productName, String
  • url, String
  • name, String
  • description, String
• GET

  Link a remote file to an item

  Links an existing remote file (googledrive, etc) to the item you supply.

  Parameters:

  • The item type, Integer
  • ID of the item to associate, Integer
  • The file type, Integer
  • Remote location, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • userId, Integer
  • dealId, Integer
  • personId, Integer
  • orgId, Integer
  • productId, Integer
  • emailMessageId, Integer
  • activityId, Integer
  • noteId, Integer
  • logId, Integer
  • addTime, String
  • updateTime, String
  • fileName, String
  • fileType, String
  • fileSize, Integer
  • activeFlag, Boolean
  • inlineFlag, Boolean
  • remoteLocation, String
  • remoteId, String
  • cid, Object
  • s3Bucket, Object
  • mailMessageId, Integer
  • dealName, String
  • personName, String
  • orgName, String
  • productName, String
  • url, String
  • name, String
  • description, String
• GET

  Update file details

  Updates the properties of a file

  Parameters:

  • Visible name of the file, String
  • Description of the file, String
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • userId, Integer
  • dealId, Integer
  • personId, Integer
  • orgId, Integer
  • productId, Integer
  • emailMessageId, Integer
  • activityId, Integer
  • noteId, Integer
  • logId, Integer
  • addTime, String
  • updateTime, String
  • fileName, String
  • fileType, String
  • fileSize, Integer
  • activeFlag, Boolean
  • inlineFlag, Boolean
  • remoteLocation, String
  • remoteId, String
  • cid, Object
  • s3Bucket, Object
  • mailMessageId, Integer
  • dealName, String
  • personName, String
  • orgName, String
  • productName, String
  • url, String
  • name, String
  • description, String
• GET

  Upload multiple files

  Lets you upload multiple files, and associate it with a Deal, a Person, an Organization, an Activity or a Product.

  Parameters:

  • Files urls, Array [String]
  • ID of the deal to associate, Integer
  • ID of the person to associate, Integer
  • ID of the organization to associate, Integer
  • ID of the product to associate, Integer
  • ID of the activity to associate, Integer
  • ID of the note to associate, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • filesList, Array [Object]

Filters

• GET

  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.

  Parameters:

  • Filter name, String
  • Filter conditions, Object
  • Type of filter, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • name, String
  • activeFlag, Boolean
  • type, String
  • temporaryFlag, Object
  • userId, Integer
  • addTime, String
  • updateTime, String
  • visibleTo, String
  • customViewId, Integer
  • conditions, Object
• GET

  Delete a filter

  Marks a filter as deleted

  Parameters:

  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Delete multiple filters in bulk

  Marks multiple filters as deleted

  Parameters:

  • Ids of essence, String
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Get all filters

  Returns data about all filters

  Parameters:

  • ID of the your pipedrive user, Integer
  • ID of the your pipedrive user, Integer

  Returns:

  • filtersList, Array [Object]
• GET

  Get one filter

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

  Parameters:

  • ID of the filter to fetch, Integer
  • ID of the your pipedrive user, Integer

  Returns:

  • id, Integer
  • name, String
  • activeFlag, Boolean
  • type, String
  • temporaryFlag, Object
  • userId, Integer
  • addTime, String
  • updateTime, String
  • visibleTo, String
  • customViewId, Integer
  • conditions, Object
• GET

  Update filter

  Updates existing filter

  Parameters:

  • Filter name, String
  • Filter conditions, String
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • name, String
  • activeFlag, Boolean
  • type, String
  • temporaryFlag, Object
  • userId, Integer
  • addTime, String
  • updateTime, String
  • visibleTo, String
  • customViewId, Integer
  • conditions, Object

GlobalMessages

• GET

  Dismiss a global message

  Removes global message from being shown, if message is dismissible

  Parameters:

  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Get global messages

  Returns data about global messages to display for the authorized user

  Parameters:

  • Limit number of messages, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • messages, Array [Object]

Goals

• GET

  Add a new goal

  Adds a new goal, returns the ID upon success

  Parameters:

  • Goal type, Integer
  • Expected type, Integer
  • ID of the associated user, Integer
  • ID of the stage, Integer
  • Period of time, Integer
  • Expected sum or number, Integer
  • Currency of the goal, String
  • ID of the pipeline, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • companyId, Integer
  • userId, Integer
  • stageId, Integer
  • activeGoalId, Integer
  • period, String
  • expected, Integer
  • activeFlag, Boolean
  • addTime, String
  • goalType, String
  • expectedSum, Integer
  • currency, String
  • expectedType, String
  • createdByUserId, Integer
  • pipelineId, Integer
  • delivered, Integer
  • deliveredSum, Integer
  • periodStart, String
  • periodEnd, String
  • userName, String
• GET

  Delete existing goal

  Delete existing goal

  Parameters:

  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Get all goals

  Returns data about all goals

  Parameters:

  • ID of the user, Integer
  • Return everyone's goals, Boolean
  • Your Pipedrive ID, Integer

  Returns:

  • goalsList, Array [Object]
• GET

  Get details of a goal

  Returns data about a specific goal.

  Parameters:

  • ID of global, Integer
  • ID of the your pipedrive user, Integer

  Returns:

  • id, Integer
  • companyId, Integer
  • userId, Integer
  • stageId, Integer
  • activeGoalId, Integer
  • period, String
  • expected, Integer
  • activeFlag, Boolean
  • addTime, String
  • goalType, String
  • expectedSum, Integer
  • currency, String
  • expectedType, String
  • createdByUserId, Integer
  • pipelineId, Integer
  • delivered, Integer
  • deliveredSum, Integer
  • periodStart, String
  • periodEnd, String
  • userName, String
• GET

  Get results of one goal

  Lists results of a specific goal

  Parameters:

  • Period start, Integer
  • Period end, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • goalsList, Array [Object]
• GET

  Update goal details

  Updates the properties of a goal

  Parameters:

  • Goal type, Integer
  • Expected type, Integer
  • ID of the associated user, Integer
  • ID of the stage, Integer
  • Period of time, Integer
  • Expected sum or number, Integer
  • Currency of the goal, String
  • ID of the pipeline, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • companyId, Integer
  • userId, Integer
  • stageId, Integer
  • activeGoalId, Integer
  • period, String
  • expected, Integer
  • activeFlag, Boolean
  • addTime, String
  • goalType, String
  • expectedSum, Integer
  • currency, String
  • expectedType, String
  • createdByUserId, Integer
  • pipelineId, Integer
  • delivered, Integer
  • deliveredSum, Integer
  • periodStart, String
  • periodEnd, String
  • userName, String

Mail

• GET

  Delete mail thread

  Marks mail thread as deleted

  Parameters:

  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Get all mail messages of mail thread

  Returns mail threads in specified folder ordered by most recent message within

  Parameters:

  • Type of folder, Integer
  • Pagination start, Integer
  • Items shown per page, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • threads, Array [Object]
• GET

  Get all mail messages of mail thread

  Get mail messages inside specified mail thread

  Parameters:

  • ID of the mail thread, Integer
  • ID of the your pipedrive user, Integer

  Returns:

  • messages, Array [Object]
• GET

  Get one mail message

  Returns data about specific mail message.

  Parameters:

  • Include message body, Boolean
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • from, Array [Object]
  • to, Array [Object]
  • cc, Array [Object]
  • bcc, Array [Object]
  • body, String
  • body_url, String
  • userId, Integer
  • mailThreadId, Integer
  • subject, String
  • snippet, String
  • readFlag, Integer
  • draft, Object
  • draftFlag, Integer
  • syncedFlag, Integer
  • deletedFlag, Integer
  • hasBodyFlag, Integer
  • sentFlag, Integer
  • smartBccFlag, Integer
  • messageTime, String
  • addTime, String
  • updateTime, String
  • hasAttachmentsFlag, Integer
  • hasInlineAttachmentsFlag, Integer
  • hasRealAttachmentsFlag, Integer
  • bodyInElasticFlag, Integer
  • writeFlag, Boolean
• GET

  Get one mail thread

  Returns specific mail thread.

  Parameters:

  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • parties, Object
  • draftsParties, Array [Object]
  • folders, Array [String]
  • userId, Integer
  • version, Integer
  • subject, String
  • snippet, String
  • snippetDraft, Object
  • snippetSent, Object
  • messageCount, Integer
  • readFlag, Integer
  • hasAttachmentsFlag, Integer
  • hasInlineAttachmentsFlag, Integer
  • hasRealAttachmentsFlag, Integer
  • hasDraftFlag, Integer
  • hasSentFlag, Integer
  • archivedFlag, Integer
  • deletedFlag, Integer
  • sharedFlag, Integer
  • syncedFlag, Integer
  • externalDeletedFlag, Integer
  • smartBccFlag, Integer
  • lastMessageTimestamp, String
  • firstMessageTimestamp, String
  • lastMessageSentTimestamp, String
  • lastMessageReceivedTimestamp, String
  • addTime, String
  • updateTime, String
  • dealId, Integer
  • writeFlag, Boolean
• GET

  Update mail thread details

  Updates the properties of a mail thread

  Parameters:

  • ID of the deal, Integer
  • Shared flag, Boolean
  • Read flag, Boolean
  • Archived flag, Boolean
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • parties, Object
  • draftsParties, Array [Object]
  • folders, Array [String]
  • userId, Integer
  • version, Integer
  • subject, String
  • snippet, String
  • snippetDraft, Object
  • snippetSent, Object
  • messageCount, Integer
  • readFlag, Integer
  • hasAttachmentsFlag, Integer
  • hasInlineAttachmentsFlag, Integer
  • hasRealAttachmentsFlag, Integer
  • hasDraftFlag, Integer
  • hasSentFlag, Integer
  • archivedFlag, Integer
  • deletedFlag, Integer
  • sharedFlag, Integer
  • syncedFlag, Integer
  • externalDeletedFlag, Integer
  • smartBccFlag, Integer
  • lastMessageTimestamp, String
  • firstMessageTimestamp, String
  • lastMessageSentTimestamp, String
  • lastMessageReceivedTimestamp, String
  • addTime, String
  • updateTime, String
  • dealId, Integer
  • writeFlag, Boolean

Notes

• GET

  Add a note

  Adds a new note

  Parameters:

  • Content of the note in HTML format, String
  • ID of the deal, Integer
  • ID of the person, Integer
  • ID of the organization, Integer
  • Pinned to deal, Boolean
  • Pinned to organization, Boolean
  • Pinned to person, Boolean
  • Your Pipedrive ID, Integer

  Returns:

  • model, Object
• GET

  Delete a note

  Deletes a specific note.

  Parameters:

  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Get all notes

  Returns all notes

  Parameters:

  • ID of the user who's notes, Integer
  • ID of the deal, Integer
  • ID of the person, Integer
  • ID of the organization, Integer
  • Pagination start, Integer
  • Items shown per page, Integer
  • Field names and sorting mode, String
  • Start date, Integer
  • End date, Integer
  • Pinned to deal, Boolean
  • Pinned to organization, Boolean
  • Pinned to person, Boolean
  • Your Pipedrive ID, Integer

  Returns:

  • notesList, Array [Object]
• GET

  Get one note

  Returns details about a specific note.

  Parameters:

  • ID of the note, Integer
  • ID of the your pipedrive user, Integer

  Returns:

  • model, Object
• GET

  Update a note

  Updates a note

  Parameters:

  • ID of the note, Integer
  • Content of the note in HTML format, String
  • ID of the deal, Integer
  • ID of the person, Integer
  • ID of the organization, Integer
  • Pinned to deal, Boolean
  • Pinned to organization, Boolean
  • Pinned to person, Boolean
  • Your Pipedrive ID, Integer

  Returns:

  • model, Object

Organization

• GET

  Create an organization relationship

  Creates and returns an organization relationship.

  Parameters:

  • ID of the base organization, Integer
  • Type of organization, Integer
  • Owner of this relationship, Integer
  • Linked organization, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • type, String
  • relOwnerOrgId, Object
  • relLinkedOrgId, Object
  • addTime, String
  • updateTime, String
  • activeFlag, Boolean
  • calculatedType, String
  • relatedOrganizationName, String
  • calculatedRelatedOrgId, Integer
• GET

  Delete an organization relationship

  Deletes an organization relationship and returns the deleted id.

  Parameters:

  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Get all relationships for organization

  Gets all of the relationships for a supplied organization id.

  Parameters:

  • ID of the organization, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • relationships, Array [Object]
• GET

  Get one organization relationship

  Finds and returns an organization relationship from its ID

  Parameters:

  • ID of the organization relationship, Integer
  • ID of the your pipedrive user, Integer
  • ID of the base organization, Integer

  Returns:

  • id, Integer
  • type, String
  • relOwnerOrgId, Object
  • relLinkedOrgId, Object
  • addTime, String
  • updateTime, String
  • activeFlag, Boolean
  • calculatedType, String
  • relatedOrganizationName, String
  • calculatedRelatedOrgId, Integer
• GET

  Update an organization relationship

  Updates and returns an organization relationship

  Parameters:

  • ID of the base organization, Integer
  • Type of organization relationship, Integer
  • Owner of this relationship, Integer
  • Linked organization, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • type, String
  • relOwnerOrgId, Object
  • relLinkedOrgId, Object
  • addTime, String
  • updateTime, String
  • activeFlag, Boolean
  • calculatedType, String
  • relatedOrganizationName, String
  • calculatedRelatedOrgId, Integer

Organizations

• GET

  Add a follower to an organization

  Adds a follower to an organization

  Parameters:

  • ID of the user, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • userId, Integer
  • id, Integer
  • dealId, Integer
  • addTime, String
• GET

  Add an organization

  Adds a new organization. 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. To determine which custom fields exists, fetch the organizationFields and look for 'key' values

  Parameters:

  • Organization name, String
  • ID of the user, Integer
  • Visibility of the organization, Integer
  • Creation date & time, Integer
  • Custom fields, Array [Object]
  • Your Pipedrive ID, Integer

  Returns:

  • model, Object
• GET

  Delete a follower from an organization

  Deletes a follower from an organization

  Parameters:

  • ID of the follower, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Delete an organization

  Marks an organization as deleted

  Parameters:

  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Delete multiple organizations in bulk

  Marks multiple organizations as deleted

  Parameters:

  • Ids of essence, String
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Find organizations by name

  Searches all organizations by their name

  Parameters:

  • Search term to look for, String
  • Pagination start, Integer
  • Items shown per page, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • organizationList, Array [Object]
• GET

  Get all organizations

  Returns all organizations

  Parameters:

  • Id of the user, Integer
  • ID of the filter, Integer
  • First char, String
  • Pagination start, Integer
  • Items shown per page, Integer
  • Field names and sorting mode, String
  • Your Pipedrive ID, Integer

  Returns:

  • organizationsList, Array [Object]
• GET

  Get details of an organization

  Returns details of an organization. Note that this also returns some additional fields which are not present when asking for all organizations. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the 'key' value of organizationFields.

  Parameters:

  • ID of the organization, Integer
  • ID of the your pipedrive user, Integer

  Returns:

  • model, Object
• GET

  List activities associated with an organization

  Lists activities associated with an organization.

  Parameters:

  • Pagination start, Integer
  • Items shown per page, Integer
  • Done or undone, Boolean
  • A comma-separated string of activity IDs, String
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • activitiesList, Array [Object]
• GET

  List deals associated with an organization

  Lists deals associated with an organization

  Parameters:

  • Pagination start, Integer
  • Items shown per page, Integer
  • Deals status, String
  • Field names, String
  • Only Primary Association, Boolean
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • dealsList, Array [Object]
• GET

  List files attached to an organization

  Lists files associated with an organization.

  Parameters:

  • Include deleted files, Boolean
  • Field names and sorting mode, String
  • Pagination start, Integer
  • Items shown per page, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • filesList, Array [Object]
• GET

  List followers of an organization

  Lists the followers of an organization

  Parameters:

  • ID of the organization, Integer
  • ID of the your pipedrive user, Integer

  Returns:

  • followersList, Array [Object]
• GET

  List mail messages associated with an organization

  Lists mail messages associated with an organization

  Parameters:

  • Pagination start, Integer
  • Items shown per page, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • messages, Array [Object]
• GET

  List permitted users

  List users permitted to access an organization

  Parameters:

  • Access level, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • usersList, Array [Integer]
• GET

  List persons of an organization

  Lists persons associated with an organization

  Parameters:

  • Pagination start, Integer
  • Items shown per page, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • personsList, Array [Object]
• GET

  List updates about an organization

  Lists updates about an organization

  Parameters:

  • Pagination start, Integer
  • Items shown per page, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • updatesList, Array [Object]
• GET

  Merge two organizations

  Merges an organization with another organization

  Parameters:

  • Merge with id, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
• GET

  Update an organization

  Updates the properties of an organization

  Parameters:

  • ID of the object, Integer
  • Organization name, String
  • ID of the user, Integer
  • Visibility of the organization, Integer
  • Creation date & time, Integer
  • Custom fields, Array [Object]
  • Your Pipedrive ID, Integer

  Returns:

  • model, Object

PermissionSets

• GET

  Add permission set assignment

  Add assignment for a permission set

  Parameters:

  • ID of the user, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • user_id, Integer
  • permission_set_id, Integer
  • name, String
• GET

  Delete a permission set assignment

  Delete assignment from a permission set

  Parameters:

  • ID of the user, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Get all permission sets

  Get all permission sets

  Parameters:

  • ID of the your pipedrive user, Integer

  Returns:

  • permissionSetsList, Array [Object]
• GET

  Get one permission set

  Get one permission set

  Parameters:

  • ID of the activity, Integer
  • ID of the your pipedrive user, Integer

  Returns:

  • id, Integer
  • name, String
  • assignment_count, String
  • contents, Array [String]
• GET

  List permission set assignments

  List assignments for a permission set

  Parameters:

  • ID of the permission set, Integer
  • ID of the your pipedrive user, Integer
  • Pagination start, Integer
  • Items shown per page, Integer

  Returns:

  • setAssignments, Array [Object]
• GET

  Update permission set details

  Update permission set details

  Parameters:

  • Permissions, String
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • name, String
  • assignment_count, String
  • contents, Array [String]

Persons

• GET

  Add a follower to a person

  Adds a follower to a person

  Parameters:

  • ID of the user, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • userId, Integer
  • id, Integer
  • dealId, Integer
  • addTime, String
• GET

  Add a person

  Adds a new person. 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. To determine which custom fields exists, fetch the personFields and look for 'key' values.

  Parameters:

  • Person name, String
  • ID of the owner user, Integer
  • ID of the organization, Integer
  • Email addresses, Array [Object]
  • Phone numbers, Array [Object]
  • Visibility of the person, Integer
  • Creation date & time, Integer
  • Custom fields, Array [Object]
  • Your Pipedrive ID, Integer

  Returns:

  • model, Object
• GET

  Add person picture

  Add 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.

  Parameters:

  • Image url, String
  • X coordinate, Integer
  • Y coordinate, Integer
  • Width, Integer
  • Height, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • itemType, String
  • itemId, Integer
  • activeFlag, Boolean
  • addTime, String
  • updateTime, String
  • addedByUserId, Integer
  • pictures, Array [Object]
• GET

  Delete a follower from a person

  Deletes a follower from a person

  Parameters:

  • ID of the follower, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Delete a person

  Marks a person as deleted

  Parameters:

  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Delete multiple persons in bulk

  Marks multiple persons as deleted

  Parameters:

  • Ids of essence, String
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Delete person picture

  Delete person picture

  Parameters:

  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Find persons by name

  Searches all persons by their name

  Parameters:

  • Search term, String
  • ID of the organization, Integer
  • Pagination start, Integer
  • Items shown per page, Integer
  • Search by email, Boolean
  • Your Pipedrive ID, Integer

  Returns:

  • personFinds, Array [Object]
• GET

  Get all persons

  Returns all persons

  Parameters:

  • ID of the user, Integer
  • ID of the filter, Integer
  • First char, String
  • Pagination start, Integer
  • Items shown per page, Integer
  • Field names and sorting mode, String
  • Your Pipedrive ID, Integer

  Returns:

  • personsList, Array [Object]
• GET

  Get details of a person

  Returns details of a person. Note that this also returns some additional fields which are not present when asking for all persons. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the 'key' value of personFields

  Parameters:

  • ID of the person, Integer
  • ID of the your pipedrive user, Integer

  Returns:

  • model, Object
• GET

  List activities associated with a person

  Lists activities associated with a person.

  Parameters:

  • Pagination start, Integer
  • Items shown per page, Integer
  • Done or undone, Boolean
  • A comma-separated string of activity IDs, String
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • activitiesList, Array [Object]
• GET

  List deals associated with a person

  Lists deals associated with a person

  Parameters:

  • Pagination start, Integer
  • Items shown per page, Integer
  • Deals status, String
  • Field names, String
  • Only Primary Association, Boolean
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • dealsList, Array [Object]
• GET

  List files attached to a person

  Lists files associated with a person

  Parameters:

  • Include deleted files, Boolean
  • Field names and sorting mode, String
  • Pagination start, Integer
  • Items shown per page, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • filesList, Array [Object]
• GET

  List followers of a person

  Lists the followers of a person.

  Parameters:

  • ID of the person, Integer
  • ID of the your pipedrive user, Integer

  Returns:

  • userId, Integer
  • id, Integer
  • dealId, Integer
  • addTime, String
• GET

  List mail messages associated with a person

  Lists mail messages associated with a person

  Parameters:

  • Pagination start, Integer
  • Items shown per page, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • messages, Array [Object]
• GET

  List permitted users

  List users permitted to access a person

  Parameters:

  • Access level, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • usersList, Array [Integer]
• GET

  List products associated with a person

  Lists products associated with a person.

  Parameters:

  • Pagination start, Integer
  • Items shown per page, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • associatedProducts, Array [Object]
• GET

  List updates about a person

  Lists updates about a person

  Parameters:

  • Pagination start, Integer
  • Items shown per page, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • updatesList, Array [Object]
• GET

  Merge two persons

  Merges a person with another person.

  Parameters:

  • Merge with id, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • companyId, Integer
  • ownerId, Integer
  • orgId, Integer
  • name, String
  • firstName, String
  • lastName, String
  • openDealsCount, Integer
  • closedDealsCount, Integer
  • participantOpenDealsCount, Integer
  • participantClosedDealsCount, Integer
  • emailMessagesCount, Integer
  • activitiesCount, Integer
  • doneActivitiesCount, Integer
  • undoneActivitiesCount, Integer
  • referenceActivitiesCount, Integer
  • filesCount, Integer
  • notesCount, Integer
  • followersCount, Integer
  • wonDealsCount, Integer
  • lostDealsCount, Integer
  • activeFlag, Boolean
  • phone, String
  • email, String
  • firstChar, String
  • updateTime, String
  • addTime, String
  • visibleTo, String
  • pictureId, Integer
  • nextActivityDate, String
  • nextActivityTime, String
  • nextActivityId, Integer
  • lastActivityId, Integer
  • lastActivityDate, String
  • lastIncomingMailTime, String
  • lastOutgoingMailTime, String
  • orgName, String
  • ownerName, String
  • ccEmail, String
  • mergeWithId, Integer
  • customFields, Array [Object]
• GET

  Update a person

  Updates the properties of a person

  Parameters:

  • Person ID, Integer
  • Person name, String
  • ID of the user, Integer
  • ID of the organization, Integer
  • Email addresses, Array [Object]
  • Phone numbers, Array [Object]
  • Visibility of the person, Integer
  • Custom fields, Array [Object]
  • Your Pipedrive ID, Integer

  Returns:

  • model, Object

Pipelines

• GET

  Add a new pipeline

  Adds a new pipeline

  Parameters:

  • Name of the pipeline, String
  • Defines piplines order, Integer
  • Hidden or active, Boolean
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • name, String
  • urlTitle, String
  • orderNr, Integer
  • active, Boolean
  • addTime, String
  • updateTime, String
  • selected, Boolean
• GET

  Delete a pipeline

  Marks a pipeline as deleted

  Parameters:

  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Edit a pipeline

  Updates pipeline properties

  Parameters:

  • Name of the pipeline, String
  • Defines piplines order, Integer
  • Hidden or active, Boolean
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • name, String
  • urlTitle, String
  • orderNr, Integer
  • active, Boolean
  • addTime, String
  • updateTime, String
  • selected, Boolean
• GET

  Get all activities assigned to a particular user

  Returns all stage-to-stage conversion and pipeline-to-close rates for given time period.

  Parameters:

  • Start of the period, Integer
  • End of the period, Integer
  • ID of the user, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • conversionStatistics, Array [Object]
• GET

  Get all activities assigned to a particular user

  Returns statistics for deals movements for given time period

  Parameters:

  • Start of the period, Integer
  • End of the period, Integer
  • ID of the user, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • movementStatistics, Array [Object]
• GET

  Get all pipelines

  Returns data about all pipelines

  Parameters:

  • ID of the your pipedrive user, Integer

  Returns:

  • pipelinesList, Array [Object]
• GET

  Get deals in a pipeline

  Lists deals in a specific pipeline across all its stages

  Parameters:

  • Id of the filter, Integer
  • ID of the user, Integer
  • Deals owned by everyone, Boolean
  • Stage id, Integer
  • Get summary, Boolean
  • 3-letter currency code, String
  • Pagination start, Integer
  • Items shown per page, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • deals, Array [Object]
• GET

  Get one pipeline

  Returns data about a specific pipeline. Also returns the summary of the deals in this pipeline across its stages

  Parameters:

  • ID of the pipeline to fetch, Integer
  • ID of the your pipedrive user, Integer
  • 3-letter currency code of any of the supported currencies, String

  Returns:

  • id, Integer
  • name, String
  • urlTitle, String
  • orderNr, Integer
  • active, Boolean
  • addTime, String
  • updateTime, String
  • selected, Boolean

Products

• GET

  Add a follower to a product

  Adds a follower to a product

  Parameters:

  • ID of the user, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • userId, Integer
  • id, Integer
  • dealId, Integer
  • addTime, String
• GET

  Add a product

  Adds a new product to the products inventory

  Parameters:

  • Name of the product, String
  • Product code, String
  • Unit in which this product is sold, String
  • Tax percentage, Integer
  • Active or not, Boolean
  • Visibility of the product, Integer
  • ID of the owner user, Integer
  • Product prices, Array [Object]
  • Custom fields, Array [Object]
  • Your Pipedrive ID, Integer

  Returns:

  • model, Object
• GET

  Add multiple products

  Adds a list of new products to the products inventory

  Parameters:

  • Products list, Array [Object]
  • Your Pipedrive ID, Integer

  Returns:

  • productsList, Array [Object]
• GET

  Delete a follower from a product

  Deletes a follower from a product

  Parameters:

  • ID of the follower, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Delete a product

  Marks a product as deleted

  Parameters:

  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Find products by name

  Returns data about the products that were found. If currency was set in request, prices in that currency are served back

  Parameters:

  • Search term, String
  • Currency code, String
  • Pagination start, Integer
  • Items shown per page, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • productsList, Array [Object]
• GET

  Get all products

  Returns data about all products

  Parameters:

  • ID of the user, Integer
  • ID of the filter, Integer
  • First char, String
  • Pagination start, Integer
  • Items shown per page, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • productsList, Array [Object]
• GET

  Get deals where a product is attached to

  Returns data about a deals that have a product attached to

  Parameters:

  • Deal status, Integer
  • Pagination start, Integer
  • Items shown per page, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • dealsList, Array [Object]
• GET

  Get one product

  Returns data about a specific products

  Parameters:

  • ID of the product, Integer
  • ID of the your pipedrive user, Integer

  Returns:

  • model, Object
• GET

  List files attached to a product

  Lists files associated with a product

  Parameters:

  • Include deleted files, Boolean
  • Field names and sorting mode, String
  • Pagination start, Integer
  • Items shown per page, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • filesList, Array [Object]
• GET

  List followers of a product

  Lists the followers of a product

  Parameters:

  • ID of the product, Integer
  • ID of the your pipedrive user, Integer

  Returns:

  • followersList, Array [Object]
• GET

  List permitted users

  List users permitted to access a product

  Parameters:

  • Access level, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • usersList, Array [Integer]
• GET

  Update a product

  Updates product data

  Parameters:

  • Name of the product, String
  • Product code, String
  • Unit in which this product is sold, String
  • Tax percentage, Integer
  • Active or not, Boolean
  • Visibility of the product, Integer
  • ID of the owner user, Integer
  • Product prices, Array [Object]
  • Custom fields, Array [Object]
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • model, Object
• GET

  Update multiple products

  Update a list of existed products in the products inventory

  Parameters:

  • Products list, Array [Object]
  • Your Pipedrive ID, Integer

  Returns:

  • productsList, Array [Object]

PushNotifications

• GET

  Create new subscription

  Creates new subscription and returns details. This endpoint is deprecated, use Create a new webhook endpoint instead

  Parameters:

  • URL where to send the notifications, String
  • Type of notifications to receive, String
  • ID of the user, Integer
  • HTTP basic auth username, String
  • HTTP basic auth password, String
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • userId, Integer
  • companyId, Integer
  • subscriptionUrl, String
  • type, String
  • event, String
  • httpAuthUser, String
  • httpAuthPassword, String
  • addTime, String
  • activeFlag, Boolean
  • removeTime, String
  • httpLastResponseCode, String
• GET

  Delete existing subscription

  Marks subscription as deleted. This endpoint is deprecated, use Delete existing webhook endpolong instead

  Parameters:

  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Get all subscriptions

  Returns data about all subscriptions. This endpoint is deprecated, use Get all webhooks endpoint instead

  Parameters:

  • ID of the your pipedrive user, Integer

  Returns:

  • notifications, Array [Object]
• GET

  Get details of a subscription

  Returns data about a specific subscription. This endpoint is deprecated and should not be used anymore

  Parameters:

  • ID of the subscriptions to fetch, Integer
  • ID of the your pipedrive user, Integer

  Returns:

  • id, Integer
  • userId, Integer
  • companyId, Integer
  • subscriptionUrl, String
  • type, String
  • event, String
  • httpAuthUser, String
  • httpAuthPassword, String
  • addTime, String
  • activeFlag, Boolean
  • removeTime, String
  • httpLastResponseCode, String

Recents

• GET

  Get recents

  Returns data about all recent changes occured after given timestamp

  Parameters:

  • Since timestamp, Integer
  • Multiple selection of item types, Integer
  • Pagination start, Integer
  • Items shown per page, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • recentsList, Array [Object]

Roles

• GET

  Add a role

  Add a role

  Parameters:

  • ID of parent role, Integer
  • Role name, String
  • Your Pipedrive ID, Integer

  Returns:
• GET

  Add or update role setting

  Add or update role setting

  Parameters:

  • Setting Key, Integer
  • Possible value, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:
• GET

  Add role assignment

  Add assignment for a role

  Parameters:

  • ID of the user, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:
• GET

  Delete a role

  Delete a role

  Parameters:

  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Delete a role assignment

  Delete assignment from a role

  Parameters:

  • ID of the user, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Get all roles

  Get all roles

  Parameters:

  • ID of the your pipedrive user, Integer
  • Pagination start, Integer
  • Items shown per page, Integer

  Returns:

  • rolesList, Array [Object]
• GET

  Get one role

  Get one role

  Parameters:

  • ID of the role, Integer
  • ID of the your pipedrive user, Integer

  Returns:
• GET

  List role assignments

  List assignments for a role

  Parameters:

  • ID of the activity, Integer
  • ID of the your pipedrive user, Integer
  • Pagination start, Integer
  • Items shown per page, Integer

  Returns:

  • assignments, Array [Object]
• GET

  List role settings

  List role settings

  Parameters:

  • ID of the role, Integer
  • ID of the your pipedrive user, Integer

  Returns:
• GET

  List role sub-roles

  List role sub-roles

  Parameters:

  • ID of the role, Integer
  • ID of the your pipedrive user, Integer
  • Pagination start, Integer
  • Items shown per page, Integer

  Returns:

  • rolesList, Array [Object]
• GET

  Update role details

  Update role details

  Parameters:

  • ID of parent role, Integer
  • Role name, String
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

SearchResults

• GET

  Perform a search

  Performs a search across the account and returns SearchResults

  Parameters:

  • Search term, String
  • Search for items, Integer
  • Pagination start, Integer
  • Items shown per page, Integer
  • Exact match, Boolean
  • Your Pipedrive ID, Integer

  Returns:

  • results, Array [Object]
• GET

  Perform a search using a specific field value

  Performs a search from a specific field's values. Results can be either the distinct values of the field (useful for searching autocomplete field values), or actual items IDs (deals, persons, organizations or products). Works only with the following field types: varchar, varchar_auto, double, address, text, phone, date

  Parameters:

  • Search term, String
  • Type of the field to perform, Integer
  • Key of the field to search from, String
  • Exact match, Boolean
  • Return field key, String
  • Return item ids, Boolean
  • Pagination start, Integer
  • Items shown per page, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • searchResult, Array [Object]

Stages

• GET

  Add a new stage

  Adds a new stage, returns the ID upon success

  Parameters:

  • Name of the stage, String
  • ID of the pipeline, Integer
  • Deal probability, Integer
  • Can become rotten, Boolean
  • Number of days the deals not updated, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • orderNr, Integer
  • name, String
  • activeFlag, Boolean
  • dealProbability, Integer
  • pipelineId, Integer
  • rottenFlag, Boolean
  • rottenDays, String
  • addTime, String
  • updateTime, String
  • pipelineName, String
• GET

  Delete a stage

  Marks a stage as deleted

  Parameters:

  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Get one stage

  Returns data about a specific stage

  Parameters:

  • ID of the stage, Integer
  • ID of the your pipedrive user, Integer

  Returns:

  • id, Integer
  • orderNr, Integer
  • name, String
  • activeFlag, Boolean
  • dealProbability, Integer
  • pipelineId, Integer
  • rottenFlag, Boolean
  • rottenDays, String
  • addTime, String
  • updateTime, String
  • pipelineName, String
• GET

  Update stage details

  Updates the properties of a stage

  Parameters:

  • Name of the stage, String
  • ID of the pipeline, Integer
  • Deal probability, Integer
  • Can become rotten, Boolean
  • Number of days the deals not updated, Integer
  • An order number for this stage, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • orderNr, Integer
  • name, String
  • activeFlag, Boolean
  • dealProbability, Integer
  • pipelineId, Integer
  • rottenFlag, Boolean
  • rottenDays, String
  • addTime, String
  • updateTime, String
  • pipelineName, String

Users

• GET

  Add a new user

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

  Parameters:

  • Name of the user, String
  • Email of the user, String
  • Active or not, Boolean
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • name, String
  • defaultCurrency, String
  • locale, String
  • lang, Integer
  • email, String
  • phone, Object
  • activated, Boolean
  • lastLogin, String
  • created, String
  • modified, String
  • signupFlowVariation, String
  • hasCreatedCompany, Boolean
  • isAdmin, Integer
  • timezoneName, String
  • timezoneOffset, String
  • activeFlag, Boolean
  • roleId, Integer
  • iconUrl, String
  • isYou, Boolean
• GET

  Add blacklisted email address for a user

  Add blacklisted email address for a specific user

  Parameters:

  • Email address to blacklist, String
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • id, Object
  • address, String
• GET

  Add permission set assignment

  Add permission set assignment for a user

  Parameters:

  • ID of the permission set, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • user_id, Integer
  • permission_set_id, Integer
  • name, String
• GET

  Add role assignment

  Add role assignment for a user

  Parameters:

  • ID of the role, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:
• GET

  Delete a permission set assignment

  Delete a permission set assignment for a user

  Parameters:

  • ID of the permission set, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Delete a role assignment

  Delete a role assignment for a user

  Parameters:

  • ID of the role, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Find users by name

  Finds users by their name

  Parameters:

  • Search term, String
  • Search by email, Boolean
  • Your Pipedrive ID, Integer

  Returns:

  • usersList, Array [Object]
• GET

  Get all user connections

  Returns data about all connections for authorized user

  Parameters:

  • ID of the your pipedrive user, Integer

  Returns:

  • connections, Array [Object]
• GET

  Get all users

  Returns data about all users within the company

  Parameters:

  • ID of the your pipedrive user, Integer

  Returns:

  • usersList, Array [Object]
• GET

  Get one user

  Returns data about a specific user within the company

  Parameters:

  • ID of the user to fetch, Integer
  • ID of the your pipedrive user, Integer

  Returns:

  • id, Integer
  • name, String
  • defaultCurrency, String
  • locale, String
  • lang, Integer
  • email, String
  • phone, Object
  • activated, Boolean
  • lastLogin, String
  • created, String
  • modified, String
  • signupFlowVariation, String
  • hasCreatedCompany, Boolean
  • isAdmin, Integer
  • timezoneName, String
  • timezoneOffset, String
  • activeFlag, Boolean
  • roleId, Integer
  • iconUrl, String
  • isYou, Boolean
• GET

  List and filter activities assigned to a specific user

  Lists activities assigned to a specific user, with optional due_date and type filtering

  Parameters:

  • Due date, Integer
  • Filter activities based on ActivityType's, String
  • Done or undone, Boolean
  • Pagination start, Integer
  • Items shown per page, Integer
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • activitiesList, Array [Object]
• GET

  List blacklisted email addresses of a user

  Lists blacklisted email addresses of a specific user. Blacklisted emails are such that will not get synced in to Pipedrive when using the built-in Mailbox

  Parameters:

  • ID of the user, Integer
  • ID of the your pipedrive user, Integer

  Returns:

  • emails, Array [Object]
• GET

  List followers of a user

  Lists followers of a specific user

  Parameters:

  • ID of the user, Integer
  • ID of the your pipedrive user, Integer

  Returns:

  • usersList, Array [Integer]
• GET

  List permission set assignments

  List permission set assignments for a user

  Parameters:

  • ID of the user, Integer
  • ID of the your pipedrive user, Integer
  • Pagination start, Integer
  • Items shown per page, Integer

  Returns:

  • id, Integer
  • user_id, Integer
  • permission_set_id, Integer
  • name, String
• GET

  List role assignments

  List role assignments for a user

  Parameters:

  • ID of the user, Integer
  • ID of the your pipedrive user, Integer
  • Pagination start, Integer
  • Items shown per page, Integer

  Returns:

  • assignments, Array [Object]
• GET

  List settings of authorized user

  Lists settings of authorized user

  Parameters:

  • ID of the your pipedrive user, Integer

  Returns:

  • showGettingStartedVideo, Boolean
  • listLimit, Integer
  • betaApp, Boolean
  • fileUploadDestination, String
  • calltoLinkSyntax, String
  • autofillDealExpectedCloseDate, Boolean
  • personDuplicateCondition, String
  • organizationDuplicateCondition, String
  • addFollowersWhenImporting, Boolean
  • searchBackend, String
  • billingManagedBySales, Boolean
  • maxDealAgeInAverageProgressCalculation, Integer
  • thirdPartyLinks, Array [Object]
  • elasticWriteTargetDuringMigration, String
  • autoCreateNewPersonsFromForwarderEmails, Boolean
  • companyAdvancedDebugLogs, Boolean
  • dealBlockOrder, Array [Object]
  • personBlockOrder, Array [Object]
  • organizationBlockOrder, Array [Object]
  • nylasSync, Boolean
  • onboardingComplete, Boolean
  • activityEmailReminders, Boolean
  • activityEmailRemindersSendType, String
  • activityEmailRemindersAmountBefore, Integer
  • fileConvertAllowed, Boolean
  • defaultCurrency, String
  • sendEmailNotifications, String
  • showUpdateNotifications, Boolean
  • mailboxSetupDone, Boolean
  • createFolderInGoogleDrive, Boolean
  • shareGoogleDriveFilesWithCompany, Boolean
  • dealsTimelineDefaultField, String
  • dealsTimelinelongerval, String
  • dealsTimelineArrangeBy, String
  • dealsTimelineColumnCount, Integer
  • dealsTimelineShowProgress, Boolean
  • shareIncomingEmails, Boolean
  • connectThreadsWithDeals, Boolean
  • emailSignature, Boolean
  • emailSignatureText, String
  • globalSearchSurveyLinkClicked, Boolean
  • googleCalendarActivityType, String
  • googleCalendarIgnoreActivityTypes, Array [Object]
  • uploadAllVisiblePersonsToGoogle, Boolean
  • formatPhoneNumbersEnabled, Boolean
  • onboardingCompletedTours, Array [Object]
  • openEmailLinksInNewTab, Boolean
  • totalsConvertCurrency, Boolean
  • emailSyncFilter, String
  • emailSyncFilterLabels, Array [Object]
  • dealDetailsOpen, Boolean
  • personDetailsOpen, Boolean
  • organizationDetailsOpen, Boolean
  • googleCalendarSubjectFormat, String
  • googleCalendarActivityReminders, Array [Object]
  • hideEmailSettingsPromotionBanner, Boolean
  • userAdvancedDebugLogs, Boolean
  • showFiltercolumnsTutorial, Boolean
  • showImportTutorial, Boolean
  • showStatisticsTutorial, Boolean
  • showActivitycrossitemTutorial, Boolean
  • hasSeenDropboxOldDetailsDeprecNotice, Boolean
  • linkPersonToOrg, Boolean
  • timezoneAutomaticUpdate, Boolean
  • usePipedriveMailtoLinks, Boolean
  • abMailPromotion1Enabled, Boolean
  • currentPipelineId, Integer
  • dealsTimelineShowWeightedValues, Boolean
  • dealsViewMode, String
  • feedViewType, String
  • filterActivities, String
  • filterDeals, String
  • filterOrg, String
  • filterPeople, String
  • filterPipeline_1, String
  • openDetailsAfterAddingDeal, Boolean
  • openDetailsAfterAddingPerson, Boolean
• GET

  List user permissions

  List aggregated permissions over all assigned permission sets for a user

  Parameters:

  • ID of the user, Integer
  • ID of the your pipedrive user, Integer

  Returns:

  • canAddProducts, Boolean
  • canBulkEditItems, Boolean
  • canChangeVisibilityOfItems, Boolean
  • canDeleteActivities, Boolean
  • canDeleteDeals, Boolean
  • canEditDealsClosedDate, Boolean
  • canEditProducts, Boolean
  • canEditSharedFilters, Boolean
  • canExportDataFromLists, Boolean
  • canFollowOtherUsers, Boolean
  • canMergeDeals, Boolean
  • canMergeOrganizations, Boolean
  • canMergePeople, Boolean
  • canSeeCompanyWideStatistics, Boolean
  • canSeeDealsListSummary, Boolean
  • canSeeHiddenItemsNames, Boolean
  • canSeeOtherUsers, Boolean
  • canSeeOtherUsersStatistics, Boolean
  • canShareFilters, Boolean
• GET

  List user role settings

  List settings of user's assigned role

  Parameters:

  • ID of the user, Integer
  • ID of the your pipedrive user, Integer

  Returns:

  • dealDefaultVisibility, Integer
  • orgDefaultVisibility, Integer
  • personDefaultVisibility, Integer
  • productDefaultVisibility, Integer
  • dealAccessLevel, Integer
  • orgAccessLevel, Integer
  • personAccessLevel, Integer
  • productAccessLevel, Integer
• GET

  Update user details

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

  Parameters:

  • Active or not, Boolean
  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • name, String
  • defaultCurrency, String
  • locale, String
  • lang, Integer
  • email, String
  • phone, Object
  • activated, Boolean
  • lastLogin, String
  • created, String
  • modified, String
  • signupFlowVariation, String
  • hasCreatedCompany, Boolean
  • isAdmin, Integer
  • timezoneName, String
  • timezoneOffset, String
  • activeFlag, Boolean
  • roleId, Integer
  • iconUrl, String
  • isYou, Boolean

Webhooks

• GET

  Creates 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, 'added.deal' for any newly added deals, 'deleted.persons' for any deleted persons, etc. See https://app.pipedrive.com/webhooks for more details.

  Parameters:

  • Subscription url, String
  • Type of action to receive, Integer
  • Type of object to receive, Integer
  • ID of the user, Integer
  • HTTP basic auth username, String
  • HTTP basic auth password, String
  • Your Pipedrive ID, Integer

  Returns:

  • id, Integer
  • company_id, Integer
  • owner_id, Integer
  • user_id, Integer
  • event_action, String
  • event_object, String
  • subscription_url, String
  • is_active, Integer
  • add_time, String
  • remove_time, String
  • type, String
  • http_auth_user, String
  • http_auth_password, String
  • last_delivery_time, String
  • last_http_status, Integer
  • admin_id, Integer
• GET

  Delete existing webhook

  Deletes the specified webhook

  Parameters:

  • ID of the object, Integer
  • Your Pipedrive ID, Integer

  Returns:

  • success, Boolean
• GET

  Get all webhooks

  Returns data about all webhooks of a company

  Parameters:

  • ID of the your pipedrive user, Integer

  Returns:

  • webhooksList, Array [Object]