Connectors

CRM & Sales

Pipedrive

Sales CRM: deals, pipelines, contacts, activities, and stage change triggers
Pipedrive API referenceAPI checked August 20, 2026
Signs in with
Connection fields
Runs on
Cloud or On-Prem Worker
Operations
371
Ready-made triggers
30

Connect Pipedrive

  1. In Neblex open Connect › Connections and click New Connection.
  2. Search for Pipedrive and give the connection a clear name.
  3. Fill in the fields. Secret values are encrypted and never shown again.
  4. Click Test, then Create Connection.
FieldWhat to enter
OAuth access tokenOptionalSecret
API tokenOptionalSecret
OAuth client IDOptional
OAuth client secretOptionalSecret

Triggers

Start a flow when something changes in Pipedrive: add a Poll for changes trigger, choose Pipedrive and pick the event.

EventWhat it doesHow
New or updated activityFires for each activity that appears or changes since the last check.Checks for changes
New or updated dealFires for each deal that appears or changes since the last check.Checks for changes
New or updated dealproductFires for each dealproduct that appears or changes since the last check.Checks for changes
New or updated fileFires for each file that appears or changes since the last check.Checks for changes
New or updated noteFires for each note that appears or changes since the last check.Checks for changes
New or updated organizationFires for each organization that appears or changes since the last check.Checks for changes
New or updated personFires for each person that appears or changes since the last check.Checks for changes
New or updated pipelineFires for each pipeline that appears or changes since the last check.Checks for changes
New or updated productFires for each product that appears or changes since the last check.Checks for changes
New or updated projectFires for each project that appears or changes since the last check.Checks for changes
New or updated projectboardFires for each projectboard that appears or changes since the last check.Checks for changes
New or updated projectphaseFires for each projectphase that appears or changes since the last check.Checks for changes
New or updated stageFires for each stage that appears or changes since the last check.Checks for changes
New or updated taskFires for each task that appears or changes since the last check.Checks for changes
New or updated userFires for each user that appears or changes since the last check.Checks for changes
New activityFires for each activity that appears since the last check.Checks for changes
New dealFires for each deal that appears since the last check.Checks for changes
New dealproductFires for each dealproduct that appears since the last check.Checks for changes
New fileFires for each file that appears since the last check.Checks for changes
New noteFires for each note that appears since the last check.Checks for changes
New organizationFires for each organization that appears since the last check.Checks for changes
New personFires for each person that appears since the last check.Checks for changes
New pipelineFires for each pipeline that appears since the last check.Checks for changes
New productFires for each product that appears since the last check.Checks for changes
New projectFires for each project that appears since the last check.Checks for changes
New projectboardFires for each projectboard that appears since the last check.Checks for changes
New projectphaseFires for each projectphase that appears since the last check.Checks for changes
New stageFires for each stage that appears since the last check.Checks for changes
New taskFires for each task that appears since the last check.Checks for changes
New userFires for each user that appears since the last check.Checks for changes

Use it in a flow

  1. Open a flow, open the node library and search for Pipedrive.
  2. Drag it onto the canvas and choose an Operation and your connection.
  3. Map the operation's fields from earlier steps, or click Map with Matt.
  4. Use Test this step to see what it returns, then save.

Operations

371 operations in 47 groups. Each one is a step you can add to a flow.

Activity5
Add a new activityaddActivityPOSTAdds a new activity.
Delete an activitydeleteActivityDELETEMarks an activity as deleted.
Get all activitiesgetActivitiesGETReturns data about all activities.
Get details of an activitygetActivityGETReturns the details of a specific activity.
Update an activityupdateActivityPATCHUpdates the properties of an activity.
ActivityField3
Get all activity fieldsgetActivityFieldsGETReturns all activity fields.
Get all activity fieldsgetActivityFieldsV2GETReturns metadata about all activity fields in the company.
Get one activity fieldgetActivityFieldGETReturns metadata about a specific activity field.
ActivityType4
Add new activity typeaddActivityTypePOSTAdds a new activity type.
Delete an activity typedeleteActivityTypeDELETEMarks an activity type as deleted.
Get all activity typesgetActivityTypesGETReturns all activity types.
Update an activity typeupdateActivityTypePUTUpdates an activity type.
Billing1
Get all add-ons for a single companygetCompanyAddonsGETReturns the add-ons for a single company.
CallLog5
Add a call logaddCallLogPOSTAdds a new call log.
Attach an audio file to the call logaddCallLogAudioFilePOSTAdds an audio recording to the call log.
Delete a call logdeleteCallLogDELETEDeletes a call log.
Get all call logs assigned to a particular usergetUserCallLogsGETReturns all call logs assigned to a particular user.
Get details of a call loggetCallLogGETReturns details of a specific call log.
Channel4
Add a channeladdChannelPOSTAdds a new messaging channel, only admins are able to register new channels.
Delete a channeldeleteChannelDELETEDeletes an existing messenger’s channel and all related entities (conversations and messages).
Delete a conversationdeleteConversationDELETEDeletes an existing conversation.
Receives an incoming messagereceiveMessagePOSTAdds a message to a conversation.
Currency1
Get all supported currenciesgetCurrenciesGETReturns all supported currencies in given account which should be used when saving monetary values with other objects.
Deal36
Add a discount to a dealpostAdditionalDiscountPOSTAdds a discount to a deal, changing the deal value if the deal has one-time products attached.
Add a follower to a dealaddDealFollowerPOSTAdds a follower to a deal.
Add a follower to a dealaddDealFollowerV2POSTAdds a user as a follower to the deal.
Add a new dealaddDealPOSTAdds a new deal.
Add a participant to a dealaddDealParticipantPOSTAdds a participant to a deal.
Convert a deal to a leadconvertDealToLeadPOSTInitiates a conversion of a deal to a lead.
Delete a dealdeleteDealDELETEMarks a deal as deleted.
Delete a discount from a dealdeleteAdditionalDiscountDELETERemoves a discount from a deal, changing the deal value if the deal has one-time products attached.
Delete a follower from a dealdeleteDealFollowerDELETEDeletes a follower from a deal.
Delete a follower from a dealdeleteDealFollowerV2DELETEDeletes a user follower from the deal.
Delete a participant from a dealdeleteDealParticipantDELETEDeletes a participant from a deal.
Duplicate dealduplicateDealPOSTDuplicates a deal.
Get all archived dealsgetArchivedDealsGETReturns all archived deals.
Get all archived dealsgetArchivedDealsV2GETReturns data about all archived deals.
Get all dealsgetDealsGETReturns data about all not archived deals.
Get archived deals summarygetArchivedDealsSummaryGETReturns a summary of all archived deals.
Get archived deals timelinegetArchivedDealsTimelineGETReturns 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...
Get Deal conversion statusgetDealConversionStatusGETReturns information about the conversion.
Get deals summarygetDealsSummaryGETReturns a summary of all not archived deals.
Get deals timelinegetDealsTimelineGETReturns 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...
Get details of a dealgetDealGETReturns the details of a specific deal.
List discounts added to a dealgetAdditionalDiscountsGETLists discounts attached to a deal.
List files attached to a dealgetDealFilesGETLists files associated with a deal.
List followers changelog of a dealgetDealFollowersChangelogGETLists changelogs about users have followed the deal.
List followers of a dealgetDealFollowersGETLists the followers of a deal.
List followers of a dealgetDealFollowersV2GETLists users who are following the deal.
List mail messages associated with a dealgetDealMailMessagesGETLists mail messages associated with a deal.
List participants of a dealgetDealParticipantsGETLists the participants associated with a deal.
List permitted usersgetDealUsersGETLists the users permitted to access a deal.
List updates about a dealgetDealUpdatesGETLists updates about a deal.
List updates about deal field valuesgetDealChangelogGETLists updates about field values of a deal.
List updates about participants of a dealgetDealParticipantsChangelogGETList updates about participants of a deal.
Merge two dealsmergeDealsPUTMerges a deal with another deal.
Search dealssearchDealsGETSearches all deals by title, notes and/or custom fields.
Update a dealupdateDealPATCHUpdates the properties of a deal.
Update a discount added to a dealupdateAdditionalDiscountPATCHEdits a discount added to a deal, changing the deal value if the deal has one-time products attached.
DealField14
Add a new deal fieldaddDealFieldPOSTAdds a new deal field.
Add deal field options in bulkaddDealFieldOptionsPOSTAdds new options to a deal custom field that supports options (enum or set field types).
Create one deal fieldaddDealFieldV2POSTCreates a new deal custom field.
Delete a deal fielddeleteDealFieldDELETEMarks a field as deleted.
Delete deal field options in bulkdeleteDealFieldOptionsDELETERemoves existing options from a deal custom field.
Delete multiple deal fields in bulkdeleteDealFieldsDELETEMarks multiple deal fields as deleted.
Delete one deal fielddeleteDealFieldV2DELETEMarks a custom field as deleted.
Get all deal fieldsgetDealFieldsGETReturns data about all deal fields.
Get all deal fieldsgetDealFieldsV2GETReturns metadata about all deal fields in the company.
Get one deal fieldgetDealFieldGETReturns data about a specific deal field.
Get one deal fieldgetDealFieldV2GETReturns metadata about a specific deal field.
Update a deal fieldupdateDealFieldPUTUpdates a deal field.
Update deal field options in bulkupdateDealFieldOptionsPATCHUpdates existing options for a deal custom field.
Update one deal fieldupdateDealFieldV2PATCHUpdates a deal custom field.
DealInstallment4
Add an installment to a dealpostInstallmentPOSTAdds an installment to a deal.
Delete an installment from a dealdeleteInstallmentDELETERemoves an installment from a deal.
List installments added to a list of dealsgetInstallmentsGETLists installments attached to a list of deals.
Update an installment added to a dealupdateInstallmentPATCHEdits an installment added to a deal.
DealProduct7
Add a product to a dealaddDealProductPOSTAdds a product to a deal, creating a new item called a deal-product.
Add multiple products to a dealaddManyDealProductsPOSTAdds multiple products to a deal in a single request.
Delete an attached product from a dealdeleteDealProductDELETEDeletes a product attachment from a deal, using the product attachment id.
Delete many products from a dealdeleteManyDealProductsDELETEDeletes multiple products from a deal.
Get deal products of several dealsgetDealsProductsGETReturns data about products attached to deals
List products attached to a dealgetDealProductsGETLists products attached to a deal.
Update the product attached to a dealupdateDealProductPATCHUpdates the details of the product that has been attached to a deal.
File8
Add fileaddFilePOSTLets you upload a file and associate it with a deal, person, organization, activity, product or lead.
Create a remote file and link it to an itemaddFileAndLinkItPOSTCreates a new empty file in the remote location (googledrive) that will be linked to the item you supply.
Delete a filedeleteFileDELETEMarks a file as deleted.
Download one filedownloadFileGETInitializes a file download.
Get all filesgetFilesGETReturns data about all files.
Get one filegetFileGETReturns data about a specific file.
Link a remote file to an itemlinkFileToItemPOSTLinks an existing remote file (googledrive) to the item you supply.
Update file detailsupdateFilePUTUpdates the properties of a file.
Filter7
Add a new filteraddFilterPOSTAdds a new filter, returns the ID upon success.
Delete a filterdeleteFilterDELETEMarks a filter as deleted.
Delete multiple filters in bulkdeleteFiltersDELETEMarks multiple filters as deleted.
Get all filter helpersgetFilterHelpersGETReturns all supported filter helpers.
Get all filtersgetFiltersGETReturns data about all filters.
Get one filtergetFilterGETReturns data about a specific filter.
Update filterupdateFilterPUTUpdates an existing filter.
Goal5
Add a new goaladdGoalPOSTAdds a new goal.
Delete existing goaldeleteGoalDELETEMarks a goal as deleted.
Find goalsgetGoalsGETReturns data about goals based on criteria.
Get result of a goalgetGoalResultGETGets the progress of a goal for the specified period.
Update existing goalupdateGoalPUTUpdates an existing goal.
ItemSearch2
Perform a search from multiple item typessearchItemGETPerforms a search from your choice of item types and fields.
Perform a search using a specific field from an item typesearchItemByFieldGETPerforms a search from the values of a specific field.
Lead11
Add a leadaddLeadPOSTCreates a lead.
Convert a lead to a dealconvertLeadToDealPOSTInitiates a conversion of a lead to a deal.
Delete a leaddeleteLeadDELETEDeletes a specific lead.
Get all archived leadsgetArchivedLeadsGETReturns multiple archived leads.
Get all leadsgetLeadsGETReturns multiple not archived leads.
Get Lead conversion statusgetLeadConversionStatusGETReturns data about the conversion.
Get one leadgetLeadGETReturns details of a specific lead.
List permitted usersgetLeadUsersGETLists the users permitted to access a lead.
Search leadssearchLeadsGETSearches all leads by title, notes and/or custom fields.
Search leadssearchLeadsV2GETSearches all leads by title, notes and/or custom fields.
Update a leadupdateLeadPATCHUpdates one or more properties of a lead.
LeadField1
Get all lead fieldsgetLeadFieldsGETReturns data about all lead fields.
LeadLabel4
Add a lead labeladdLeadLabelPOSTCreates a lead label.
Delete a lead labeldeleteLeadLabelDELETEDeletes a specific lead label.
Get all lead labelsgetLeadLabelsGETReturns details of all lead labels.
Update a lead labelupdateLeadLabelPATCHUpdates one or more properties of a lead label.
LeadSource1
Get all lead sourcesgetLeadSourcesGETReturns all lead sources.
LegacyTeam8
Add a new teamaddTeamPOSTAdds a new team to the company and returns the created object.
Add users to a teamaddTeamUserPOSTAdds users to an existing team.
Delete users from a teamdeleteTeamUserDELETEDeletes users from an existing team.
Get a single teamgetTeamGETReturns data about a specific team.
Get all teamsgetTeamsGETReturns data about teams within the company.
Get all teams of a usergetUserTeamsGETReturns data about all teams which have the specified user as a member.
Get all users in a teamgetTeamUsersGETReturns a list of all user IDs within a team.
Update a teamupdateTeamPUTUpdates an existing team and returns the updated object.
Mailbox6
Delete mail threaddeleteMailThreadDELETEMarks a mail thread as deleted.
Get all mail messages of mail threadgetMailThreadMessagesGETReturns all the mail messages inside a specified mail thread.
Get mail threadsgetMailThreadsGETReturns mail threads in a specified folder ordered by the most recent message within.
Get one mail messagegetMailMessageGETReturns data about a specific mail message.
Get one mail threadgetMailThreadGETReturns a specific mail thread.
Update mail thread detailsupdateMailThreadDetailsPUTUpdates the properties of a mail thread.
Meeting2
Delete the link between a user and the installed video calldeleteUserProviderLinkDELETEA video calling provider must call this endpoint to remove the link between a user and the installed video calling app.
Link a user with the installed video call integrationsaveUserProviderLinkPOSTA 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.
Note10
Add a comment to a noteaddNoteCommentPOSTAdds a new comment to a note.
Add a noteaddNotePOSTAdds a new note.
Delete a comment related to a notedeleteCommentDELETEDeletes a comment.
Delete a notedeleteNoteDELETEDeletes a specific note.
Get all comments for a notegetNoteCommentsGETReturns all comments associated with a note.
Get all notesgetNotesGETReturns all notes.
Get one commentgetCommentGETReturns the details of a comment.
Get one notegetNoteGETReturns details about a specific note.
Update a comment related to a noteupdateCommentForNotePUTUpdates a comment related to a note.
Update a noteupdateNotePUTUpdates a note.
NoteField1
Get all note fieldsgetNoteFieldsGETReturns data about all note fields.
Oauth3
Getting the tokensget_tokensPOSTAfter the customer has confirmed the app installation, you will need to exchange the authorization code to a pair of access and refresh tokens.
Refreshing the tokensrefresh_tokensPOSTThe access token has a lifetime.
Requesting authorizationauthorizeGETAuthorize a user by redirecting them to the Pipedrive OAuth authorization page and request their permissions to act on their behalf.
Organization19
Add a follower to an organizationaddOrganizationFollowerPOSTAdds a follower to an organization.
Add a follower to an organizationaddOrganizationFollowerV2POSTAdds a user as a follower to the organization.
Add a new organizationaddOrganizationPOSTAdds a new organization.
Delete a follower from an organizationdeleteOrganizationFollowerDELETEDeletes a follower from an organization.
Delete a follower from an organizationdeleteOrganizationFollowerV2DELETEDeletes a user follower from the organization.
Delete a organizationdeleteOrganizationDELETEMarks a organization as deleted.
Get all organizationsgetOrganizationsGETReturns data about all organizations.
Get details of a organizationgetOrganizationGETReturns the details of a specific organization.
List files attached to an organizationgetOrganizationFilesGETLists files associated with an organization.
List followers changelog of an organizationgetOrganizationFollowersChangelogGETLists changelogs about users have followed the organization.
List followers of an organizationgetOrganizationFollowersGETLists the followers of an organization.
List followers of an organizationgetOrganizationFollowersV2GETLists users who are following the organization.
List mail messages associated with an organizationgetOrganizationMailMessagesGETLists mail messages associated with an organization.
List permitted usersgetOrganizationUsersGETList users permitted to access an organization.
List updates about an organizationgetOrganizationUpdatesGETLists updates about an organization.
List updates about organization field valuesgetOrganizationChangelogGETLists updates about field values of an organization.
Merge two organizationsmergeOrganizationsPUTMerges an organization with another organization.
Search organizationssearchOrganizationGETSearches all organizations by name, address, notes and/or custom fields.
Update a organizationupdateOrganizationPATCHUpdates the properties of a organization.
OrganizationField14
Add a new organization fieldaddOrganizationFieldPOSTAdds a new organization field.
Add organization field options in bulkaddOrganizationFieldOptionsPOSTAdds new options to an organization custom field that supports options (enum or set field types).
Create one organization fieldaddOrganizationFieldV2POSTCreates a new organization custom field.
Delete an organization fielddeleteOrganizationFieldDELETEMarks a field as deleted.
Delete multiple organization fields in bulkdeleteOrganizationFieldsDELETEMarks multiple fields as deleted.
Delete one organization fielddeleteOrganizationFieldV2DELETEMarks a custom field as deleted.
Delete organization field options in bulkdeleteOrganizationFieldOptionsDELETERemoves existing options from an organization custom field.
Get all organization fieldsgetOrganizationFieldsGETReturns data about all organization fields.
Get all organization fieldsgetOrganizationFieldsV2GETReturns metadata about all organization fields in the company.
Get one organization fieldgetOrganizationFieldGETReturns data about a specific organization field.
Get one organization fieldgetOrganizationFieldV2GETReturns metadata about a specific organization field.
Update an organization fieldupdateOrganizationFieldPUTUpdates an organization field.
Update one organization fieldupdateOrganizationFieldV2PATCHUpdates an organization custom field.
Update organization field options in bulkupdateOrganizationFieldOptionsPATCHUpdates existing options for an organization custom field.
OrganizationRelationship5
Create an organization relationshipaddOrganizationRelationshipPOSTCreates and returns an organization relationship.
Delete an organization relationshipdeleteOrganizationRelationshipDELETEDeletes an organization relationship and returns the deleted ID.
Get all relationships for organizationgetOrganizationRelationshipsGETGets all of the relationships for a supplied organization ID.
Get one organization relationshipgetOrganizationRelationshipGETFinds and returns an organization relationship from its ID.
Update an organization relationshipupdateOrganizationRelationshipPUTUpdates and returns an organization relationship.
PermissionSet3
Get all permission setsgetPermissionSetsGETReturns data about all permission sets.
Get one permission setgetPermissionSetGETReturns data about a specific permission set.
List permission set assignmentsgetPermissionSetAssignmentsGETReturns the list of assignments for a permission set.
Person23
Add a follower to a personaddPersonFollowerPOSTAdds a follower to a person.
Add a follower to a personaddPersonFollowerV2POSTAdds a user as a follower to the person.
Add a new personaddPersonPOSTAdds a new person.
Add person pictureaddPersonPicturePOSTAdds a picture to a person.
Delete a follower from a persondeletePersonFollowerDELETEDeletes a follower from a person.
Delete a follower from a persondeletePersonFollowerV2DELETEDeletes a user follower from the person.
Delete a persondeletePersonDELETEMarks a person as deleted.
Delete person picturedeletePersonPictureDELETEDeletes a person’s picture.
Get all personsgetPersonsGETReturns data about all persons.
Get details of a persongetPersonGETReturns the details of a specific person.
Get picture of a persongetPersonPictureGETReturns the picture associated with a person.
List files attached to a persongetPersonFilesGETLists files associated with a person.
List followers changelog of a persongetPersonFollowersChangelogGETLists changelogs about users have followed the person.
List followers of a persongetPersonFollowersGETLists the followers of a person.
List followers of a persongetPersonFollowersV2GETLists users who are following the person.
List mail messages associated with a persongetPersonMailMessagesGETLists mail messages associated with a person.
List permitted usersgetPersonUsersGETList users permitted to access a person.
List products associated with a persongetPersonProductsGETLists products associated with a person.
List updates about a persongetPersonUpdatesGETLists updates about a person.
List updates about person field valuesgetPersonChangelogGETLists updates about field values of a person.
Merge two personsmergePersonsPUTMerges a person with another person.
Search personssearchPersonsGETSearches all persons by name, email, phone, notes and/or custom fields.
Update a personupdatePersonPATCHUpdates the properties of a person.
PersonField14
Add a new person fieldaddPersonFieldPOSTAdds a new person field.
Add person field options in bulkaddPersonFieldOptionsPOSTAdds new options to a person custom field that supports options (enum or set field types).
Create one person fieldaddPersonFieldV2POSTCreates a new person custom field.
Delete a person fielddeletePersonFieldDELETEMarks a field as deleted.
Delete multiple person fields in bulkdeletePersonFieldsDELETEMarks multiple fields as deleted.
Delete one person fielddeletePersonFieldV2DELETEMarks a custom field as deleted.
Delete person field options in bulkdeletePersonFieldOptionsDELETERemoves existing options from a person custom field.
Get all person fieldsgetPersonFieldsGETReturns data about all person fields.
Get all person fieldsgetPersonFieldsV2GETReturns metadata about all person fields in the company.
Get one person fieldgetPersonFieldGETReturns data about a specific person field.
Get one person fieldgetPersonFieldV2GETReturns metadata about a specific person field.
Update a person fieldupdatePersonFieldPUTUpdates a person field.
Update one person fieldupdatePersonFieldV2PATCHUpdates a person custom field.
Update person field options in bulkupdatePersonFieldOptionsPATCHUpdates existing options for a person custom field.
Pipeline8
Add a new pipelineaddPipelinePOSTAdds a new pipeline.
Delete a pipelinedeletePipelineDELETEMarks a pipeline as deleted.
Get all pipelinesgetPipelinesGETReturns data about all pipelines.
Get deals conversion rates in pipelinegetPipelineConversionStatisticsGETReturns all stage-to-stage conversion and pipeline-to-close rates for the given time period.
Get deals in a pipelinegetPipelineDealsGETLists deals in a specific pipeline across all its stages.
Get deals movements in pipelinegetPipelineMovementStatisticsGETReturns statistics for deals movements for the given time period.
Get one pipelinegetPipelineGETReturns data about a specific pipeline.
Update a pipelineupdatePipelinePATCHUpdates the properties of a pipeline.
Product25
Add a follower to a productaddProductFollowerPOSTAdds a follower to a product.
Add a follower to a productaddProductFollowerV2POSTAdds a user as a follower to the product.
Add a productaddProductPOSTAdds a new product to the Products inventory.
Add a product variationaddProductVariationPOSTAdds a new product variation.
Delete a follower from a productdeleteProductFollowerDELETEDeletes a follower from a product.
Delete a follower from a productdeleteProductFollowerV2DELETEDeletes a user follower from the product.
Delete a productdeleteProductDELETEMarks a product as deleted.
Delete a product variationdeleteProductVariationDELETEDeletes a product variation.
Delete an image of a productdeleteProductImageDELETEDeletes the image of a product.
Duplicate a productduplicateProductPOSTCreates a duplicate of an existing product including all variations, prices, and custom fields.
Get all product variationsgetProductVariationsGETReturns data about all product variations.
Get all productsgetProductsGETReturns data about all products.
Get deals where a product is attached togetProductDealsGETReturns data about deals that have a product attached to it.
Get image of a productgetProductImageGETRetrieves the image of a product.
Get one productgetProductGETReturns data about a specific product.
List files attached to a productgetProductFilesGETLists files associated with a product.
List followers changelog of a productgetProductFollowersChangelogGETLists changelogs about users have followed the product.
List followers of a productgetProductFollowersGETLists the followers of a product.
List followers of a productgetProductFollowersV2GETLists users who are following the product.
List permitted usersgetProductUsersGETLists users permitted to access a product.
Search productssearchProductsGETSearches all products by name, code and/or custom fields.
Update a productupdateProductPATCHUpdates product data.
Update a product variationupdateProductVariationPATCHUpdates product variation data.
Update an image for a productupdateProductImagePUTUpdates the image of a product.
Upload an image for a productuploadProductImagePOSTUploads an image for a product.
ProductField14
Add a new product fieldaddProductFieldPOSTAdds a new product field.
Add product field options in bulkaddProductFieldOptionsPOSTAdds new options to a product custom field that supports options (enum or set field types).
Create one product fieldaddProductFieldV2POSTCreates a new product custom field.
Delete a product fielddeleteProductFieldDELETEMarks a product field as deleted.
Delete multiple product fields in bulkdeleteProductFieldsDELETEMarks multiple fields as deleted.
Delete one product fielddeleteProductFieldV2DELETEMarks a custom field as deleted.
Delete product field options in bulkdeleteProductFieldOptionsDELETERemoves existing options from a product custom field.
Get all product fieldsgetProductFieldsGETReturns data about all product fields.
Get all product fieldsgetProductFieldsV2GETReturns metadata about all product fields in the company.
Get one product fieldgetProductFieldGETReturns data about a specific product field.
Get one product fieldgetProductFieldV2GETReturns metadata about a specific product field.
Update a product fieldupdateProductFieldPUTUpdates a product field.
Update one product fieldupdateProductFieldV2PATCHUpdates a product custom field.
Update product field options in bulkupdateProductFieldOptionsPATCHUpdates existing options for a product custom field.
Project22
Add a projectaddProjectPOSTAdds a new project.
Add a projectaddProjectV2POSTAdds a new project.
Archive a projectarchiveProjectPOSTArchives a project.
Archive a projectarchiveProjectV2POSTArchives a project.
Delete a projectdeleteProjectDELETEMarks a project as deleted.
Delete a projectdeleteProjectV2DELETEMarks a project as deleted.
Get all archived projectsgetArchivedProjectsGETReturns all archived projects.
Get all projectsgetProjectsGETReturns all projects.
Get all projectsgetProjectsV2GETReturns all non-archived projects.
Get details of a projectgetProjectGETReturns the details of a specific project.
Get details of a projectgetProjectV2GETReturns the details of a specific project.
List permitted usersgetProjectUsersGETLists the users permitted to access a project.
List updates about project field valuesgetProjectChangelogGETLists updates about field values of a project.
Returns project activitiesgetProjectActivitiesGETReturns activities linked to a specific project.
Returns project groupsgetProjectGroupsGETReturns all active groups under a specific project.
Returns project plangetProjectPlanGETReturns information about items in a project plan.
Returns project tasksgetProjectTasksGETReturns tasks linked to a specific project.
Search projectssearchProjectsGETSearches all projects by title, description, notes and/or custom fields.
Update a projectupdateProjectPUTUpdates a project.
Update a projectupdateProjectV2PATCHUpdates the properties of a project.
Update activity in project planputProjectPlanActivityPUTUpdates an activity phase or group in a project.
Update task in project planputProjectPlanTaskPUTUpdates a task phase or group in a project.
ProjectBoard7
Add a project boardaddProjectBoardPOSTAdds a new project board.
Delete a project boarddeleteProjectBoardDELETEMarks a project board as deleted.
Get all project boardsgetProjectsBoardsGETReturns all projects boards that are not deleted.
Get all project boardsgetProjectsBoardsV2GETReturns all active project boards.
Get details of a boardgetProjectsBoardGETReturns the details of a specific project board.
Get details of a project boardgetProjectsBoardV2GETReturns the details of a specific project board.
Update a project boardupdateProjectBoardPATCHUpdates the properties of a project board.
ProjectField8
Add project field options in bulkaddProjectFieldOptionsPOSTAdds new options to a project custom field that supports options (enum or set field types).
Create one project fieldaddProjectFieldPOSTCreates a new project custom field.
Delete one project fielddeleteProjectFieldDELETEMarks a custom field as deleted.
Delete project field options in bulkdeleteProjectFieldOptionsDELETERemoves existing options from a project custom field.
Get all project fieldsgetProjectFieldsGETReturns metadata about all project fields in the company.
Get one project fieldgetProjectFieldGETReturns metadata about a specific project field.
Update one project fieldupdateProjectFieldPATCHUpdates a project custom field.
Update project field options in bulkupdateProjectFieldOptionsPATCHUpdates existing options for a project custom field.
ProjectPhase7
Add a project phaseaddProjectPhasePOSTAdds a new project phase to a board.
Delete a project phasedeleteProjectPhaseDELETEMarks a project phase as deleted.
Get details of a phasegetProjectsPhaseGETReturns the details of a specific project phase.
Get details of a project phasegetProjectsPhaseV2GETReturns the details of a specific project phase.
Get project phasesgetProjectsPhasesGETReturns all active project phases under a specific board.
Get project phasesgetProjectsPhasesV2GETReturns all active project phases under a specific board.
Update a project phaseupdateProjectPhasePATCHUpdates the properties of a project phase.
ProjectTemplate4
Get all project templatesgetProjectTemplatesGETReturns all not deleted project templates.
Get all project templatesgetProjectTemplatesV2GETReturns all not deleted project templates.
Get details of a templategetProjectTemplateGETReturns the details of a specific project template.
Get details of a templategetProjectTemplateV2GETReturns the details of a specific project template.
Recent1
Get recentsgetRecentsGETReturns data about all recent changes occurred after the given timestamp.
Role12
Add a roleaddRolePOSTAdds a new role.
Add or update role settingaddOrUpdateRoleSettingPOSTAdds or updates the visibility setting for a role.
Add role assignmentaddRoleAssignmentPOSTAssigns a user to a role.
Delete a roledeleteRoleDELETEMarks a role as deleted.
Delete a role assignmentdeleteRoleAssignmentDELETERemoves the assigned user from a role and adds to the default role.
Get all rolesgetRolesGETReturns all the roles within the company.
Get one rolegetRoleGETReturns the details of a specific role.
List pipeline visibility for a rolegetRolePipelinesGETReturns the list of either visible or hidden pipeline IDs for a specific role.
List role assignmentsgetRoleAssignmentsGETReturns all users assigned to a role.
List role settingsgetRoleSettingsGETReturns the visibility settings of a specific role.
Update pipeline visibility for a roleupdateRolePipelinesPUTUpdates the specified pipelines to be visible and/or hidden for a specific role.
Update role detailsupdateRolePUTUpdates the parent role and/or the name of a specific role.
Stage6
Add a new stageaddStagePOSTAdds a new stage, returns the ID upon success.
Delete a stagedeleteStageDELETEMarks a stage as deleted.
Get all stagesgetStagesGETReturns data about all stages.
Get deals in a stagegetStageDealsGETLists deals in a specific stage.
Get one stagegetStageGETReturns data about a specific stage.
Update stage detailsupdateStagePATCHUpdates the properties of a stage.
Task10
Add a taskaddTaskPOSTAdds a new task.
Add a taskaddTaskV2POSTAdds a new task.
Delete a taskdeleteTaskDELETEMarks a task as deleted.
Delete a taskdeleteTaskV2DELETEMarks a task as deleted.
Get all tasksgetTasksGETReturns all tasks.
Get all tasksgetTasksV2GETReturns all tasks.
Get details of a taskgetTaskGETReturns the details of a specific task.
Get details of a taskgetTaskV2GETReturns the details of a specific task.
Update a taskupdateTaskPUTUpdates a task.
Update a taskupdateTaskV2PATCHUpdates a task.
User11
Add a new useraddUserPOSTAdds a new user to the company, returns the ID upon success.
Find users by namefindUsersByNameGETFinds users by their name.
Get all usersgetUsersGETReturns data about all users within the company.
Get current user datagetCurrentUserGETReturns data about an authorized user within the company with bound company data: company ID, company name, and domain.
Get one usergetUserGETReturns data about a specific user within the company.
List followers of a usergetUserFollowersGETLists the followers of a specific user.
List followers of a usergetUserFollowersV2GETLists users who are following the user.
List role assignmentsgetUserRoleAssignmentsGETLists role assignments for a user.
List user permissionsgetUserPermissionsGETLists aggregated permissions over all assigned permission sets for a user.
List user role settingsgetUserRoleSettingsGETLists the settings of user's assigned role.
Update user detailsupdateUserPUTUpdates the properties of a user.
UserConnection1
Get all user connectionsgetUserConnectionsGETReturns data about all connections for the authorized user.
UserSetting1
List settings of an authorized usergetUserSettingsGETLists the settings of an authorized user.
Webhook3
Create a new WebhookaddWebhookPOSTCreates a new Webhook and returns its details.
Delete existing WebhookdeleteWebhookDELETEDeletes the specified Webhook.
Get all WebhooksgetWebhooksGETReturns data about all the Webhooks of a company.