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
- In Neblex open Connect › Connections and click New Connection.
- Search for Pipedrive and give the connection a clear name.
- Fill in the fields. Secret values are encrypted and never shown again.
- Click Test, then Create Connection.
| Field | What 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.
| Event | What it does | How |
|---|---|---|
| New or updated activity | Fires for each activity that appears or changes since the last check. | Checks for changes |
| New or updated deal | Fires for each deal that appears or changes since the last check. | Checks for changes |
| New or updated dealproduct | Fires for each dealproduct that appears or changes since the last check. | Checks for changes |
| New or updated file | Fires for each file that appears or changes since the last check. | Checks for changes |
| New or updated note | Fires for each note that appears or changes since the last check. | Checks for changes |
| New or updated organization | Fires for each organization that appears or changes since the last check. | Checks for changes |
| New or updated person | Fires for each person that appears or changes since the last check. | Checks for changes |
| New or updated pipeline | Fires for each pipeline that appears or changes since the last check. | Checks for changes |
| New or updated product | Fires for each product that appears or changes since the last check. | Checks for changes |
| New or updated project | Fires for each project that appears or changes since the last check. | Checks for changes |
| New or updated projectboard | Fires for each projectboard that appears or changes since the last check. | Checks for changes |
| New or updated projectphase | Fires for each projectphase that appears or changes since the last check. | Checks for changes |
| New or updated stage | Fires for each stage that appears or changes since the last check. | Checks for changes |
| New or updated task | Fires for each task that appears or changes since the last check. | Checks for changes |
| New or updated user | Fires for each user that appears or changes since the last check. | Checks for changes |
| New activity | Fires for each activity that appears since the last check. | Checks for changes |
| New deal | Fires for each deal that appears since the last check. | Checks for changes |
| New dealproduct | Fires for each dealproduct that appears since the last check. | Checks for changes |
| New file | Fires for each file that appears since the last check. | Checks for changes |
| New note | Fires for each note that appears since the last check. | Checks for changes |
| New organization | Fires for each organization that appears since the last check. | Checks for changes |
| New person | Fires for each person that appears since the last check. | Checks for changes |
| New pipeline | Fires for each pipeline that appears since the last check. | Checks for changes |
| New product | Fires for each product that appears since the last check. | Checks for changes |
| New project | Fires for each project that appears since the last check. | Checks for changes |
| New projectboard | Fires for each projectboard that appears since the last check. | Checks for changes |
| New projectphase | Fires for each projectphase that appears since the last check. | Checks for changes |
| New stage | Fires for each stage that appears since the last check. | Checks for changes |
| New task | Fires for each task that appears since the last check. | Checks for changes |
| New user | Fires for each user that appears since the last check. | Checks for changes |
Use it in a flow
- Open a flow, open the node library and search for Pipedrive.
- Drag it onto the canvas and choose an Operation and your connection.
- Map the operation's fields from earlier steps, or click Map with Matt.
- 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 activityaddActivity | POST | Adds a new activity. |
Delete an activitydeleteActivity | DELETE | Marks an activity as deleted. |
Get all activitiesgetActivities | GET | Returns data about all activities. |
Get details of an activitygetActivity | GET | Returns the details of a specific activity. |
Update an activityupdateActivity | PATCH | Updates the properties of an activity. |
ActivityField3
Get all activity fieldsgetActivityFields | GET | Returns all activity fields. |
Get all activity fieldsgetActivityFieldsV2 | GET | Returns metadata about all activity fields in the company. |
Get one activity fieldgetActivityField | GET | Returns metadata about a specific activity field. |
ActivityType4
Add new activity typeaddActivityType | POST | Adds a new activity type. |
Delete an activity typedeleteActivityType | DELETE | Marks an activity type as deleted. |
Get all activity typesgetActivityTypes | GET | Returns all activity types. |
Update an activity typeupdateActivityType | PUT | Updates an activity type. |
Billing1
Get all add-ons for a single companygetCompanyAddons | GET | Returns the add-ons for a single company. |
CallLog5
Add a call logaddCallLog | POST | Adds a new call log. |
Attach an audio file to the call logaddCallLogAudioFile | POST | Adds an audio recording to the call log. |
Delete a call logdeleteCallLog | DELETE | Deletes a call log. |
Get all call logs assigned to a particular usergetUserCallLogs | GET | Returns all call logs assigned to a particular user. |
Get details of a call loggetCallLog | GET | Returns details of a specific call log. |
Channel4
Add a channeladdChannel | POST | Adds a new messaging channel, only admins are able to register new channels. |
Delete a channeldeleteChannel | DELETE | Deletes an existing messenger’s channel and all related entities (conversations and messages). |
Delete a conversationdeleteConversation | DELETE | Deletes an existing conversation. |
Receives an incoming messagereceiveMessage | POST | Adds a message to a conversation. |
Currency1
Get all supported currenciesgetCurrencies | GET | Returns all supported currencies in given account which should be used when saving monetary values with other objects. |
Deal36
Add a discount to a dealpostAdditionalDiscount | POST | Adds a discount to a deal, changing the deal value if the deal has one-time products attached. |
Add a follower to a dealaddDealFollower | POST | Adds a follower to a deal. |
Add a follower to a dealaddDealFollowerV2 | POST | Adds a user as a follower to the deal. |
Add a new dealaddDeal | POST | Adds a new deal. |
Add a participant to a dealaddDealParticipant | POST | Adds a participant to a deal. |
Convert a deal to a leadconvertDealToLead | POST | Initiates a conversion of a deal to a lead. |
Delete a dealdeleteDeal | DELETE | Marks a deal as deleted. |
Delete a discount from a dealdeleteAdditionalDiscount | DELETE | Removes a discount from a deal, changing the deal value if the deal has one-time products attached. |
Delete a follower from a dealdeleteDealFollower | DELETE | Deletes a follower from a deal. |
Delete a follower from a dealdeleteDealFollowerV2 | DELETE | Deletes a user follower from the deal. |
Delete a participant from a dealdeleteDealParticipant | DELETE | Deletes a participant from a deal. |
Duplicate dealduplicateDeal | POST | Duplicates a deal. |
Get all archived dealsgetArchivedDeals | GET | Returns all archived deals. |
Get all archived dealsgetArchivedDealsV2 | GET | Returns data about all archived deals. |
Get all dealsgetDeals | GET | Returns data about all not archived deals. |
Get archived deals summarygetArchivedDealsSummary | GET | Returns a summary of all archived deals. |
Get archived deals timelinegetArchivedDealsTimeline | GET | Returns archived open and won deals, grouped by a defined interval of time set in a date-type dealField (field key) - e.g. when month is the chosen interval, and 3 months are asked... |
Get Deal conversion statusgetDealConversionStatus | GET | Returns information about the conversion. |
Get deals summarygetDealsSummary | GET | Returns a summary of all not archived deals. |
Get deals timelinegetDealsTimeline | GET | Returns not archived open and won deals, grouped by a defined interval of time set in a date-type dealField (field key) - e.g. when month is the chosen interval, and 3 months are asked... |
Get details of a dealgetDeal | GET | Returns the details of a specific deal. |
List discounts added to a dealgetAdditionalDiscounts | GET | Lists discounts attached to a deal. |
List files attached to a dealgetDealFiles | GET | Lists files associated with a deal. |
List followers changelog of a dealgetDealFollowersChangelog | GET | Lists changelogs about users have followed the deal. |
List followers of a dealgetDealFollowers | GET | Lists the followers of a deal. |
List followers of a dealgetDealFollowersV2 | GET | Lists users who are following the deal. |
List mail messages associated with a dealgetDealMailMessages | GET | Lists mail messages associated with a deal. |
List participants of a dealgetDealParticipants | GET | Lists the participants associated with a deal. |
List permitted usersgetDealUsers | GET | Lists the users permitted to access a deal. |
List updates about a dealgetDealUpdates | GET | Lists updates about a deal. |
List updates about deal field valuesgetDealChangelog | GET | Lists updates about field values of a deal. |
List updates about participants of a dealgetDealParticipantsChangelog | GET | List updates about participants of a deal. |
Merge two dealsmergeDeals | PUT | Merges a deal with another deal. |
Search dealssearchDeals | GET | Searches all deals by title, notes and/or custom fields. |
Update a dealupdateDeal | PATCH | Updates the properties of a deal. |
Update a discount added to a dealupdateAdditionalDiscount | PATCH | Edits a discount added to a deal, changing the deal value if the deal has one-time products attached. |
DealField14
Add a new deal fieldaddDealField | POST | Adds a new deal field. |
Add deal field options in bulkaddDealFieldOptions | POST | Adds new options to a deal custom field that supports options (enum or set field types). |
Create one deal fieldaddDealFieldV2 | POST | Creates a new deal custom field. |
Delete a deal fielddeleteDealField | DELETE | Marks a field as deleted. |
Delete deal field options in bulkdeleteDealFieldOptions | DELETE | Removes existing options from a deal custom field. |
Delete multiple deal fields in bulkdeleteDealFields | DELETE | Marks multiple deal fields as deleted. |
Delete one deal fielddeleteDealFieldV2 | DELETE | Marks a custom field as deleted. |
Get all deal fieldsgetDealFields | GET | Returns data about all deal fields. |
Get all deal fieldsgetDealFieldsV2 | GET | Returns metadata about all deal fields in the company. |
Get one deal fieldgetDealField | GET | Returns data about a specific deal field. |
Get one deal fieldgetDealFieldV2 | GET | Returns metadata about a specific deal field. |
Update a deal fieldupdateDealField | PUT | Updates a deal field. |
Update deal field options in bulkupdateDealFieldOptions | PATCH | Updates existing options for a deal custom field. |
Update one deal fieldupdateDealFieldV2 | PATCH | Updates a deal custom field. |
DealInstallment4
Add an installment to a dealpostInstallment | POST | Adds an installment to a deal. |
Delete an installment from a dealdeleteInstallment | DELETE | Removes an installment from a deal. |
List installments added to a list of dealsgetInstallments | GET | Lists installments attached to a list of deals. |
Update an installment added to a dealupdateInstallment | PATCH | Edits an installment added to a deal. |
DealProduct7
Add a product to a dealaddDealProduct | POST | Adds a product to a deal, creating a new item called a deal-product. |
Add multiple products to a dealaddManyDealProducts | POST | Adds multiple products to a deal in a single request. |
Delete an attached product from a dealdeleteDealProduct | DELETE | Deletes a product attachment from a deal, using the product attachment id. |
Delete many products from a dealdeleteManyDealProducts | DELETE | Deletes multiple products from a deal. |
Get deal products of several dealsgetDealsProducts | GET | Returns data about products attached to deals |
List products attached to a dealgetDealProducts | GET | Lists products attached to a deal. |
Update the product attached to a dealupdateDealProduct | PATCH | Updates the details of the product that has been attached to a deal. |
File8
Add fileaddFile | POST | Lets 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 itemaddFileAndLinkIt | POST | Creates a new empty file in the remote location (googledrive) that will be linked to the item you supply. |
Delete a filedeleteFile | DELETE | Marks a file as deleted. |
Download one filedownloadFile | GET | Initializes a file download. |
Get all filesgetFiles | GET | Returns data about all files. |
Get one filegetFile | GET | Returns data about a specific file. |
Link a remote file to an itemlinkFileToItem | POST | Links an existing remote file (googledrive) to the item you supply. |
Update file detailsupdateFile | PUT | Updates the properties of a file. |
Filter7
Add a new filteraddFilter | POST | Adds a new filter, returns the ID upon success. |
Delete a filterdeleteFilter | DELETE | Marks a filter as deleted. |
Delete multiple filters in bulkdeleteFilters | DELETE | Marks multiple filters as deleted. |
Get all filter helpersgetFilterHelpers | GET | Returns all supported filter helpers. |
Get all filtersgetFilters | GET | Returns data about all filters. |
Get one filtergetFilter | GET | Returns data about a specific filter. |
Update filterupdateFilter | PUT | Updates an existing filter. |
Goal5
Add a new goaladdGoal | POST | Adds a new goal. |
Delete existing goaldeleteGoal | DELETE | Marks a goal as deleted. |
Find goalsgetGoals | GET | Returns data about goals based on criteria. |
Get result of a goalgetGoalResult | GET | Gets the progress of a goal for the specified period. |
Update existing goalupdateGoal | PUT | Updates an existing goal. |
ItemSearch2
Perform a search from multiple item typessearchItem | GET | Performs a search from your choice of item types and fields. |
Perform a search using a specific field from an item typesearchItemByField | GET | Performs a search from the values of a specific field. |
Lead11
Add a leadaddLead | POST | Creates a lead. |
Convert a lead to a dealconvertLeadToDeal | POST | Initiates a conversion of a lead to a deal. |
Delete a leaddeleteLead | DELETE | Deletes a specific lead. |
Get all archived leadsgetArchivedLeads | GET | Returns multiple archived leads. |
Get all leadsgetLeads | GET | Returns multiple not archived leads. |
Get Lead conversion statusgetLeadConversionStatus | GET | Returns data about the conversion. |
Get one leadgetLead | GET | Returns details of a specific lead. |
List permitted usersgetLeadUsers | GET | Lists the users permitted to access a lead. |
Search leadssearchLeads | GET | Searches all leads by title, notes and/or custom fields. |
Search leadssearchLeadsV2 | GET | Searches all leads by title, notes and/or custom fields. |
Update a leadupdateLead | PATCH | Updates one or more properties of a lead. |
LeadField1
Get all lead fieldsgetLeadFields | GET | Returns data about all lead fields. |
LeadLabel4
Add a lead labeladdLeadLabel | POST | Creates a lead label. |
Delete a lead labeldeleteLeadLabel | DELETE | Deletes a specific lead label. |
Get all lead labelsgetLeadLabels | GET | Returns details of all lead labels. |
Update a lead labelupdateLeadLabel | PATCH | Updates one or more properties of a lead label. |
LeadSource1
Get all lead sourcesgetLeadSources | GET | Returns all lead sources. |
LegacyTeam8
Add a new teamaddTeam | POST | Adds a new team to the company and returns the created object. |
Add users to a teamaddTeamUser | POST | Adds users to an existing team. |
Delete users from a teamdeleteTeamUser | DELETE | Deletes users from an existing team. |
Get a single teamgetTeam | GET | Returns data about a specific team. |
Get all teamsgetTeams | GET | Returns data about teams within the company. |
Get all teams of a usergetUserTeams | GET | Returns data about all teams which have the specified user as a member. |
Get all users in a teamgetTeamUsers | GET | Returns a list of all user IDs within a team. |
Update a teamupdateTeam | PUT | Updates an existing team and returns the updated object. |
Mailbox6
Delete mail threaddeleteMailThread | DELETE | Marks a mail thread as deleted. |
Get all mail messages of mail threadgetMailThreadMessages | GET | Returns all the mail messages inside a specified mail thread. |
Get mail threadsgetMailThreads | GET | Returns mail threads in a specified folder ordered by the most recent message within. |
Get one mail messagegetMailMessage | GET | Returns data about a specific mail message. |
Get one mail threadgetMailThread | GET | Returns a specific mail thread. |
Update mail thread detailsupdateMailThreadDetails | PUT | Updates the properties of a mail thread. |
Meeting2
Delete the link between a user and the installed video calldeleteUserProviderLink | DELETE | A 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 integrationsaveUserProviderLink | POST | A video calling provider must call this endpoint after a user has installed the video calling app so that the new user's information is sent. |
Note10
Add a comment to a noteaddNoteComment | POST | Adds a new comment to a note. |
Add a noteaddNote | POST | Adds a new note. |
Delete a comment related to a notedeleteComment | DELETE | Deletes a comment. |
Delete a notedeleteNote | DELETE | Deletes a specific note. |
Get all comments for a notegetNoteComments | GET | Returns all comments associated with a note. |
Get all notesgetNotes | GET | Returns all notes. |
Get one commentgetComment | GET | Returns the details of a comment. |
Get one notegetNote | GET | Returns details about a specific note. |
Update a comment related to a noteupdateCommentForNote | PUT | Updates a comment related to a note. |
Update a noteupdateNote | PUT | Updates a note. |
NoteField1
Get all note fieldsgetNoteFields | GET | Returns data about all note fields. |
Oauth3
Getting the tokensget_tokens | POST | After 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_tokens | POST | The access token has a lifetime. |
Requesting authorizationauthorize | GET | Authorize 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 organizationaddOrganizationFollower | POST | Adds a follower to an organization. |
Add a follower to an organizationaddOrganizationFollowerV2 | POST | Adds a user as a follower to the organization. |
Add a new organizationaddOrganization | POST | Adds a new organization. |
Delete a follower from an organizationdeleteOrganizationFollower | DELETE | Deletes a follower from an organization. |
Delete a follower from an organizationdeleteOrganizationFollowerV2 | DELETE | Deletes a user follower from the organization. |
Delete a organizationdeleteOrganization | DELETE | Marks a organization as deleted. |
Get all organizationsgetOrganizations | GET | Returns data about all organizations. |
Get details of a organizationgetOrganization | GET | Returns the details of a specific organization. |
List files attached to an organizationgetOrganizationFiles | GET | Lists files associated with an organization. |
List followers changelog of an organizationgetOrganizationFollowersChangelog | GET | Lists changelogs about users have followed the organization. |
List followers of an organizationgetOrganizationFollowers | GET | Lists the followers of an organization. |
List followers of an organizationgetOrganizationFollowersV2 | GET | Lists users who are following the organization. |
List mail messages associated with an organizationgetOrganizationMailMessages | GET | Lists mail messages associated with an organization. |
List permitted usersgetOrganizationUsers | GET | List users permitted to access an organization. |
List updates about an organizationgetOrganizationUpdates | GET | Lists updates about an organization. |
List updates about organization field valuesgetOrganizationChangelog | GET | Lists updates about field values of an organization. |
Merge two organizationsmergeOrganizations | PUT | Merges an organization with another organization. |
Search organizationssearchOrganization | GET | Searches all organizations by name, address, notes and/or custom fields. |
Update a organizationupdateOrganization | PATCH | Updates the properties of a organization. |
OrganizationField14
Add a new organization fieldaddOrganizationField | POST | Adds a new organization field. |
Add organization field options in bulkaddOrganizationFieldOptions | POST | Adds new options to an organization custom field that supports options (enum or set field types). |
Create one organization fieldaddOrganizationFieldV2 | POST | Creates a new organization custom field. |
Delete an organization fielddeleteOrganizationField | DELETE | Marks a field as deleted. |
Delete multiple organization fields in bulkdeleteOrganizationFields | DELETE | Marks multiple fields as deleted. |
Delete one organization fielddeleteOrganizationFieldV2 | DELETE | Marks a custom field as deleted. |
Delete organization field options in bulkdeleteOrganizationFieldOptions | DELETE | Removes existing options from an organization custom field. |
Get all organization fieldsgetOrganizationFields | GET | Returns data about all organization fields. |
Get all organization fieldsgetOrganizationFieldsV2 | GET | Returns metadata about all organization fields in the company. |
Get one organization fieldgetOrganizationField | GET | Returns data about a specific organization field. |
Get one organization fieldgetOrganizationFieldV2 | GET | Returns metadata about a specific organization field. |
Update an organization fieldupdateOrganizationField | PUT | Updates an organization field. |
Update one organization fieldupdateOrganizationFieldV2 | PATCH | Updates an organization custom field. |
Update organization field options in bulkupdateOrganizationFieldOptions | PATCH | Updates existing options for an organization custom field. |
OrganizationRelationship5
Create an organization relationshipaddOrganizationRelationship | POST | Creates and returns an organization relationship. |
Delete an organization relationshipdeleteOrganizationRelationship | DELETE | Deletes an organization relationship and returns the deleted ID. |
Get all relationships for organizationgetOrganizationRelationships | GET | Gets all of the relationships for a supplied organization ID. |
Get one organization relationshipgetOrganizationRelationship | GET | Finds and returns an organization relationship from its ID. |
Update an organization relationshipupdateOrganizationRelationship | PUT | Updates and returns an organization relationship. |
PermissionSet3
Get all permission setsgetPermissionSets | GET | Returns data about all permission sets. |
Get one permission setgetPermissionSet | GET | Returns data about a specific permission set. |
List permission set assignmentsgetPermissionSetAssignments | GET | Returns the list of assignments for a permission set. |
Person23
Add a follower to a personaddPersonFollower | POST | Adds a follower to a person. |
Add a follower to a personaddPersonFollowerV2 | POST | Adds a user as a follower to the person. |
Add a new personaddPerson | POST | Adds a new person. |
Add person pictureaddPersonPicture | POST | Adds a picture to a person. |
Delete a follower from a persondeletePersonFollower | DELETE | Deletes a follower from a person. |
Delete a follower from a persondeletePersonFollowerV2 | DELETE | Deletes a user follower from the person. |
Delete a persondeletePerson | DELETE | Marks a person as deleted. |
Delete person picturedeletePersonPicture | DELETE | Deletes a person’s picture. |
Get all personsgetPersons | GET | Returns data about all persons. |
Get details of a persongetPerson | GET | Returns the details of a specific person. |
Get picture of a persongetPersonPicture | GET | Returns the picture associated with a person. |
List files attached to a persongetPersonFiles | GET | Lists files associated with a person. |
List followers changelog of a persongetPersonFollowersChangelog | GET | Lists changelogs about users have followed the person. |
List followers of a persongetPersonFollowers | GET | Lists the followers of a person. |
List followers of a persongetPersonFollowersV2 | GET | Lists users who are following the person. |
List mail messages associated with a persongetPersonMailMessages | GET | Lists mail messages associated with a person. |
List permitted usersgetPersonUsers | GET | List users permitted to access a person. |
List products associated with a persongetPersonProducts | GET | Lists products associated with a person. |
List updates about a persongetPersonUpdates | GET | Lists updates about a person. |
List updates about person field valuesgetPersonChangelog | GET | Lists updates about field values of a person. |
Merge two personsmergePersons | PUT | Merges a person with another person. |
Search personssearchPersons | GET | Searches all persons by name, email, phone, notes and/or custom fields. |
Update a personupdatePerson | PATCH | Updates the properties of a person. |
PersonField14
Add a new person fieldaddPersonField | POST | Adds a new person field. |
Add person field options in bulkaddPersonFieldOptions | POST | Adds new options to a person custom field that supports options (enum or set field types). |
Create one person fieldaddPersonFieldV2 | POST | Creates a new person custom field. |
Delete a person fielddeletePersonField | DELETE | Marks a field as deleted. |
Delete multiple person fields in bulkdeletePersonFields | DELETE | Marks multiple fields as deleted. |
Delete one person fielddeletePersonFieldV2 | DELETE | Marks a custom field as deleted. |
Delete person field options in bulkdeletePersonFieldOptions | DELETE | Removes existing options from a person custom field. |
Get all person fieldsgetPersonFields | GET | Returns data about all person fields. |
Get all person fieldsgetPersonFieldsV2 | GET | Returns metadata about all person fields in the company. |
Get one person fieldgetPersonField | GET | Returns data about a specific person field. |
Get one person fieldgetPersonFieldV2 | GET | Returns metadata about a specific person field. |
Update a person fieldupdatePersonField | PUT | Updates a person field. |
Update one person fieldupdatePersonFieldV2 | PATCH | Updates a person custom field. |
Update person field options in bulkupdatePersonFieldOptions | PATCH | Updates existing options for a person custom field. |
Pipeline8
Add a new pipelineaddPipeline | POST | Adds a new pipeline. |
Delete a pipelinedeletePipeline | DELETE | Marks a pipeline as deleted. |
Get all pipelinesgetPipelines | GET | Returns data about all pipelines. |
Get deals conversion rates in pipelinegetPipelineConversionStatistics | GET | Returns all stage-to-stage conversion and pipeline-to-close rates for the given time period. |
Get deals in a pipelinegetPipelineDeals | GET | Lists deals in a specific pipeline across all its stages. |
Get deals movements in pipelinegetPipelineMovementStatistics | GET | Returns statistics for deals movements for the given time period. |
Get one pipelinegetPipeline | GET | Returns data about a specific pipeline. |
Update a pipelineupdatePipeline | PATCH | Updates the properties of a pipeline. |
Product25
Add a follower to a productaddProductFollower | POST | Adds a follower to a product. |
Add a follower to a productaddProductFollowerV2 | POST | Adds a user as a follower to the product. |
Add a productaddProduct | POST | Adds a new product to the Products inventory. |
Add a product variationaddProductVariation | POST | Adds a new product variation. |
Delete a follower from a productdeleteProductFollower | DELETE | Deletes a follower from a product. |
Delete a follower from a productdeleteProductFollowerV2 | DELETE | Deletes a user follower from the product. |
Delete a productdeleteProduct | DELETE | Marks a product as deleted. |
Delete a product variationdeleteProductVariation | DELETE | Deletes a product variation. |
Delete an image of a productdeleteProductImage | DELETE | Deletes the image of a product. |
Duplicate a productduplicateProduct | POST | Creates a duplicate of an existing product including all variations, prices, and custom fields. |
Get all product variationsgetProductVariations | GET | Returns data about all product variations. |
Get all productsgetProducts | GET | Returns data about all products. |
Get deals where a product is attached togetProductDeals | GET | Returns data about deals that have a product attached to it. |
Get image of a productgetProductImage | GET | Retrieves the image of a product. |
Get one productgetProduct | GET | Returns data about a specific product. |
List files attached to a productgetProductFiles | GET | Lists files associated with a product. |
List followers changelog of a productgetProductFollowersChangelog | GET | Lists changelogs about users have followed the product. |
List followers of a productgetProductFollowers | GET | Lists the followers of a product. |
List followers of a productgetProductFollowersV2 | GET | Lists users who are following the product. |
List permitted usersgetProductUsers | GET | Lists users permitted to access a product. |
Search productssearchProducts | GET | Searches all products by name, code and/or custom fields. |
Update a productupdateProduct | PATCH | Updates product data. |
Update a product variationupdateProductVariation | PATCH | Updates product variation data. |
Update an image for a productupdateProductImage | PUT | Updates the image of a product. |
Upload an image for a productuploadProductImage | POST | Uploads an image for a product. |
ProductField14
Add a new product fieldaddProductField | POST | Adds a new product field. |
Add product field options in bulkaddProductFieldOptions | POST | Adds new options to a product custom field that supports options (enum or set field types). |
Create one product fieldaddProductFieldV2 | POST | Creates a new product custom field. |
Delete a product fielddeleteProductField | DELETE | Marks a product field as deleted. |
Delete multiple product fields in bulkdeleteProductFields | DELETE | Marks multiple fields as deleted. |
Delete one product fielddeleteProductFieldV2 | DELETE | Marks a custom field as deleted. |
Delete product field options in bulkdeleteProductFieldOptions | DELETE | Removes existing options from a product custom field. |
Get all product fieldsgetProductFields | GET | Returns data about all product fields. |
Get all product fieldsgetProductFieldsV2 | GET | Returns metadata about all product fields in the company. |
Get one product fieldgetProductField | GET | Returns data about a specific product field. |
Get one product fieldgetProductFieldV2 | GET | Returns metadata about a specific product field. |
Update a product fieldupdateProductField | PUT | Updates a product field. |
Update one product fieldupdateProductFieldV2 | PATCH | Updates a product custom field. |
Update product field options in bulkupdateProductFieldOptions | PATCH | Updates existing options for a product custom field. |
Project22
Add a projectaddProject | POST | Adds a new project. |
Add a projectaddProjectV2 | POST | Adds a new project. |
Archive a projectarchiveProject | POST | Archives a project. |
Archive a projectarchiveProjectV2 | POST | Archives a project. |
Delete a projectdeleteProject | DELETE | Marks a project as deleted. |
Delete a projectdeleteProjectV2 | DELETE | Marks a project as deleted. |
Get all archived projectsgetArchivedProjects | GET | Returns all archived projects. |
Get all projectsgetProjects | GET | Returns all projects. |
Get all projectsgetProjectsV2 | GET | Returns all non-archived projects. |
Get details of a projectgetProject | GET | Returns the details of a specific project. |
Get details of a projectgetProjectV2 | GET | Returns the details of a specific project. |
List permitted usersgetProjectUsers | GET | Lists the users permitted to access a project. |
List updates about project field valuesgetProjectChangelog | GET | Lists updates about field values of a project. |
Returns project activitiesgetProjectActivities | GET | Returns activities linked to a specific project. |
Returns project groupsgetProjectGroups | GET | Returns all active groups under a specific project. |
Returns project plangetProjectPlan | GET | Returns information about items in a project plan. |
Returns project tasksgetProjectTasks | GET | Returns tasks linked to a specific project. |
Search projectssearchProjects | GET | Searches all projects by title, description, notes and/or custom fields. |
Update a projectupdateProject | PUT | Updates a project. |
Update a projectupdateProjectV2 | PATCH | Updates the properties of a project. |
Update activity in project planputProjectPlanActivity | PUT | Updates an activity phase or group in a project. |
Update task in project planputProjectPlanTask | PUT | Updates a task phase or group in a project. |
ProjectBoard7
Add a project boardaddProjectBoard | POST | Adds a new project board. |
Delete a project boarddeleteProjectBoard | DELETE | Marks a project board as deleted. |
Get all project boardsgetProjectsBoards | GET | Returns all projects boards that are not deleted. |
Get all project boardsgetProjectsBoardsV2 | GET | Returns all active project boards. |
Get details of a boardgetProjectsBoard | GET | Returns the details of a specific project board. |
Get details of a project boardgetProjectsBoardV2 | GET | Returns the details of a specific project board. |
Update a project boardupdateProjectBoard | PATCH | Updates the properties of a project board. |
ProjectField8
Add project field options in bulkaddProjectFieldOptions | POST | Adds new options to a project custom field that supports options (enum or set field types). |
Create one project fieldaddProjectField | POST | Creates a new project custom field. |
Delete one project fielddeleteProjectField | DELETE | Marks a custom field as deleted. |
Delete project field options in bulkdeleteProjectFieldOptions | DELETE | Removes existing options from a project custom field. |
Get all project fieldsgetProjectFields | GET | Returns metadata about all project fields in the company. |
Get one project fieldgetProjectField | GET | Returns metadata about a specific project field. |
Update one project fieldupdateProjectField | PATCH | Updates a project custom field. |
Update project field options in bulkupdateProjectFieldOptions | PATCH | Updates existing options for a project custom field. |
ProjectPhase7
Add a project phaseaddProjectPhase | POST | Adds a new project phase to a board. |
Delete a project phasedeleteProjectPhase | DELETE | Marks a project phase as deleted. |
Get details of a phasegetProjectsPhase | GET | Returns the details of a specific project phase. |
Get details of a project phasegetProjectsPhaseV2 | GET | Returns the details of a specific project phase. |
Get project phasesgetProjectsPhases | GET | Returns all active project phases under a specific board. |
Get project phasesgetProjectsPhasesV2 | GET | Returns all active project phases under a specific board. |
Update a project phaseupdateProjectPhase | PATCH | Updates the properties of a project phase. |
ProjectTemplate4
Get all project templatesgetProjectTemplates | GET | Returns all not deleted project templates. |
Get all project templatesgetProjectTemplatesV2 | GET | Returns all not deleted project templates. |
Get details of a templategetProjectTemplate | GET | Returns the details of a specific project template. |
Get details of a templategetProjectTemplateV2 | GET | Returns the details of a specific project template. |
Recent1
Get recentsgetRecents | GET | Returns data about all recent changes occurred after the given timestamp. |
Role12
Add a roleaddRole | POST | Adds a new role. |
Add or update role settingaddOrUpdateRoleSetting | POST | Adds or updates the visibility setting for a role. |
Add role assignmentaddRoleAssignment | POST | Assigns a user to a role. |
Delete a roledeleteRole | DELETE | Marks a role as deleted. |
Delete a role assignmentdeleteRoleAssignment | DELETE | Removes the assigned user from a role and adds to the default role. |
Get all rolesgetRoles | GET | Returns all the roles within the company. |
Get one rolegetRole | GET | Returns the details of a specific role. |
List pipeline visibility for a rolegetRolePipelines | GET | Returns the list of either visible or hidden pipeline IDs for a specific role. |
List role assignmentsgetRoleAssignments | GET | Returns all users assigned to a role. |
List role settingsgetRoleSettings | GET | Returns the visibility settings of a specific role. |
Update pipeline visibility for a roleupdateRolePipelines | PUT | Updates the specified pipelines to be visible and/or hidden for a specific role. |
Update role detailsupdateRole | PUT | Updates the parent role and/or the name of a specific role. |
Stage6
Add a new stageaddStage | POST | Adds a new stage, returns the ID upon success. |
Delete a stagedeleteStage | DELETE | Marks a stage as deleted. |
Get all stagesgetStages | GET | Returns data about all stages. |
Get deals in a stagegetStageDeals | GET | Lists deals in a specific stage. |
Get one stagegetStage | GET | Returns data about a specific stage. |
Update stage detailsupdateStage | PATCH | Updates the properties of a stage. |
Task10
Add a taskaddTask | POST | Adds a new task. |
Add a taskaddTaskV2 | POST | Adds a new task. |
Delete a taskdeleteTask | DELETE | Marks a task as deleted. |
Delete a taskdeleteTaskV2 | DELETE | Marks a task as deleted. |
Get all tasksgetTasks | GET | Returns all tasks. |
Get all tasksgetTasksV2 | GET | Returns all tasks. |
Get details of a taskgetTask | GET | Returns the details of a specific task. |
Get details of a taskgetTaskV2 | GET | Returns the details of a specific task. |
Update a taskupdateTask | PUT | Updates a task. |
Update a taskupdateTaskV2 | PATCH | Updates a task. |
User11
Add a new useraddUser | POST | Adds a new user to the company, returns the ID upon success. |
Find users by namefindUsersByName | GET | Finds users by their name. |
Get all usersgetUsers | GET | Returns data about all users within the company. |
Get current user datagetCurrentUser | GET | Returns data about an authorized user within the company with bound company data: company ID, company name, and domain. |
Get one usergetUser | GET | Returns data about a specific user within the company. |
List followers of a usergetUserFollowers | GET | Lists the followers of a specific user. |
List followers of a usergetUserFollowersV2 | GET | Lists users who are following the user. |
List role assignmentsgetUserRoleAssignments | GET | Lists role assignments for a user. |
List user permissionsgetUserPermissions | GET | Lists aggregated permissions over all assigned permission sets for a user. |
List user role settingsgetUserRoleSettings | GET | Lists the settings of user's assigned role. |
Update user detailsupdateUser | PUT | Updates the properties of a user. |
UserConnection1
Get all user connectionsgetUserConnections | GET | Returns data about all connections for the authorized user. |
UserSetting1
List settings of an authorized usergetUserSettings | GET | Lists the settings of an authorized user. |
Webhook3
Create a new WebhookaddWebhook | POST | Creates a new Webhook and returns its details. |
Delete existing WebhookdeleteWebhook | DELETE | Deletes the specified Webhook. |
Get all WebhooksgetWebhooks | GET | Returns data about all the Webhooks of a company. |