@utdk/pipedrive

Pipedrive API v1

Generated UTDK provider client for Pipedrive API v1. Generated UTDK provider types and OpenAPI-backed client for https://developers.pipedrive.com/docs/api/v1/openapi.yaml.

Import sample

import pipedrive from "@utdk/pipedrive"

Factory sample

import { createPipedriveClient } from "@utdk/pipedrive"

Provider path: pipedrive
Source API title: Pipedrive API v1
Version: 1.0.0
Generated: May 30, 2026, 6:16 PM
Homepage: Open site
API spec: View spec

README

Embedded directly from the package source.

pipedrive

Generated UTDK provider types and OpenAPI-backed client for https://developers.pipedrive.com/docs/api/v1/openapi.yaml.

Operations

213 operations — open try-it console

Method	Operation ID	Path	Summary
GET	getActivityFields	/activityFields	Get all activity fields	Try
GET	getActivityTypes	/activityTypes	Get all activity types	Try
POST	addActivityType	/activityTypes	Add new activity type	Try
PUT	updateActivityType	/activityTypes/{id}	Update an activity type	Try
DELETE	deleteActivityType	/activityTypes/{id}	Delete an activity type	Try
GET	getCompanyAddons	/billing/subscriptions/addons	Get all add-ons for a single company	Try
GET	getUserCallLogs	/callLogs	Get all call logs assigned to a particular user	Try
POST	addCallLog	/callLogs	Add a call log	Try
GET	getCallLog	/callLogs/{id}	Get details of a call log	Try
DELETE	deleteCallLog	/callLogs/{id}	Delete a call log	Try
POST	addCallLogAudioFile	/callLogs/{id}/recordings	Attach an audio file to the call log	Try
POST	addChannel	/channels	Add a channel	Try
DELETE	deleteChannel	/channels/{id}	Delete a channel	Try
POST	receiveMessage	/channels/messages/receive	Receives an incoming message	Try
DELETE	deleteConversation	/channels/{channel-id}/conversations/{conversation-id}	Delete a conversation	Try
GET	getCurrencies	/currencies	Get all supported currencies	Try
GET	getArchivedDeals	/deals/archived	Get all archived deals	Try
GET	getDealsSummary	/deals/summary	Get deals summary	Try
GET	getArchivedDealsSummary	/deals/summary/archived	Get archived deals summary	Try
GET	getDealsTimeline	/deals/timeline	Get deals timeline	Try
GET	getArchivedDealsTimeline	/deals/timeline/archived	Get archived deals timeline	Try
GET	getDealChangelog	/deals/{id}/changelog	List updates about deal field values	Try
POST	duplicateDeal	/deals/{id}/duplicate	Duplicate deal	Try
GET	getDealFiles	/deals/{id}/files	List files attached to a deal	Try
GET	getDealUpdates	/deals/{id}/flow	List updates about a deal	Try
GET	getDealParticipantsChangelog	/deals/{id}/participantsChangelog	List updates about participants of a deal	Try
GET	getDealFollowers	/deals/{id}/followers	List followers of a deal	Try
POST	addDealFollower	/deals/{id}/followers	Add a follower to a deal	Try
DELETE	deleteDealFollower	/deals/{id}/followers/{follower_id}	Delete a follower from a deal	Try
GET	getDealMailMessages	/deals/{id}/mailMessages	List mail messages associated with a deal	Try
PUT	mergeDeals	/deals/{id}/merge	Merge two deals	Try
GET	getDealParticipants	/deals/{id}/participants	List participants of a deal	Try
POST	addDealParticipant	/deals/{id}/participants	Add a participant to a deal	Try
DELETE	deleteDealParticipant	/deals/{id}/participants/{deal_participant_id}	Delete a participant from a deal	Try
GET	getDealUsers	/deals/{id}/permittedUsers	List permitted users	Try
GET	getDealFields	/dealFields	Get all deal fields	Try
POST	addDealField	/dealFields	Add a new deal field	Try
DELETE	deleteDealFields	/dealFields	Delete multiple deal fields in bulk	Try
GET	getDealField	/dealFields/{id}	Get one deal field	Try
PUT	updateDealField	/dealFields/{id}	Update a deal field	Try
DELETE	deleteDealField	/dealFields/{id}	Delete a deal field	Try
GET	getFiles	/files	Get all files	Try
POST	addFile	/files	Add file	Try
POST	addFileAndLinkIt	/files/remote	Create a remote file and link it to an item	Try
POST	linkFileToItem	/files/remoteLink	Link a remote file to an item	Try
GET	getFile	/files/{id}	Get one file	Try
PUT	updateFile	/files/{id}	Update file details	Try
DELETE	deleteFile	/files/{id}	Delete a file	Try
GET	downloadFile	/files/{id}/download	Download one file	Try
GET	getFilters	/filters	Get all filters	Try
POST	addFilter	/filters	Add a new filter	Try
DELETE	deleteFilters	/filters	Delete multiple filters in bulk	Try
GET	getFilterHelpers	/filters/helpers	Get all filter helpers	Try
GET	getFilter	/filters/{id}	Get one filter	Try
PUT	updateFilter	/filters/{id}	Update filter	Try
DELETE	deleteFilter	/filters/{id}	Delete a filter	Try
POST	addGoal	/goals	Add a new goal	Try
GET	getGoals	/goals/find	Find goals	Try
PUT	updateGoal	/goals/{id}	Update existing goal	Try
DELETE	deleteGoal	/goals/{id}	Delete existing goal	Try
GET	getGoalResult	/goals/{id}/results	Get result of a goal	Try
GET	getLeads	/leads	Get all leads	Try
POST	addLead	/leads	Add a lead	Try
GET	getArchivedLeads	/leads/archived	Get all archived leads	Try
GET	getLead	/leads/{id}	Get one lead	Try
PATCH	updateLead	/leads/{id}	Update a lead	Try
DELETE	deleteLead	/leads/{id}	Delete a lead	Try
GET	getLeadUsers	/leads/{id}/permittedUsers	List permitted users	Try
GET	searchLeads	/leads/search	Search leads	Try
GET	getLeadFields	/leadFields	Get all lead fields	Try
GET	getLeadLabels	/leadLabels	Get all lead labels	Try
POST	addLeadLabel	/leadLabels	Add a lead label	Try
PATCH	updateLeadLabel	/leadLabels/{id}	Update a lead label	Try
DELETE	deleteLeadLabel	/leadLabels/{id}	Delete a lead label	Try
GET	getLeadSources	/leadSources	Get all lead sources	Try
GET	getTeams	/legacyTeams	Get all teams	Try
POST	addTeam	/legacyTeams	Add a new team	Try
GET	getTeam	/legacyTeams/{id}	Get a single team	Try
PUT	updateTeam	/legacyTeams/{id}	Update a team	Try
GET	getTeamUsers	/legacyTeams/{id}/users	Get all users in a team	Try
POST	addTeamUser	/legacyTeams/{id}/users	Add users to a team	Try
DELETE	deleteTeamUser	/legacyTeams/{id}/users	Delete users from a team	Try
GET	getUserTeams	/legacyTeams/user/{id}	Get all teams of a user	Try
GET	getMailMessage	/mailbox/mailMessages/{id}	Get one mail message	Try
GET	getMailThreads	/mailbox/mailThreads	Get mail threads	Try
GET	getMailThread	/mailbox/mailThreads/{id}	Get one mail thread	Try
PUT	updateMailThreadDetails	/mailbox/mailThreads/{id}	Update mail thread details	Try
DELETE	deleteMailThread	/mailbox/mailThreads/{id}	Delete mail thread	Try
GET	getMailThreadMessages	/mailbox/mailThreads/{id}/mailMessages	Get all mail messages of mail thread	Try
POST	saveUserProviderLink	/meetings/userProviderLinks	Link a user with the installed video call integration	Try
DELETE	deleteUserProviderLink	/meetings/userProviderLinks/{id}	Delete the link between a user and the installed video call integration	Try
GET	getNotes	/notes	Get all notes	Try
POST	addNote	/notes	Add a note	Try
GET	getNote	/notes/{id}	Get one note	Try
PUT	updateNote	/notes/{id}	Update a note	Try
DELETE	deleteNote	/notes/{id}	Delete a note	Try
GET	getNoteComments	/notes/{id}/comments	Get all comments for a note	Try
POST	addNoteComment	/notes/{id}/comments	Add a comment to a note	Try
GET	getComment	/notes/{id}/comments/{commentId}	Get one comment	Try
PUT	updateCommentForNote	/notes/{id}/comments/{commentId}	Update a comment related to a note	Try
DELETE	deleteComment	/notes/{id}/comments/{commentId}	Delete a comment related to a note	Try
GET	getNoteFields	/noteFields	Get all note fields	Try
GET	authorize	/oauth/authorize	Requesting authorization	Try
POST	get-tokens	/oauth/token	Getting the tokens	Try
POST	refresh-tokens	/oauth/token/	Refreshing the tokens	Try
GET	getOrganizationChangelog	/organizations/{id}/changelog	List updates about organization field values	Try
GET	getOrganizationFiles	/organizations/{id}/files	List files attached to an organization	Try
GET	getOrganizationUpdates	/organizations/{id}/flow	List updates about an organization	Try
GET	getOrganizationFollowers	/organizations/{id}/followers	List followers of an organization	Try
POST	addOrganizationFollower	/organizations/{id}/followers	Add a follower to an organization	Try
DELETE	deleteOrganizationFollower	/organizations/{id}/followers/{follower_id}	Delete a follower from an organization	Try
GET	getOrganizationMailMessages	/organizations/{id}/mailMessages	List mail messages associated with an organization	Try
PUT	mergeOrganizations	/organizations/{id}/merge	Merge two organizations	Try
GET	getOrganizationUsers	/organizations/{id}/permittedUsers	List permitted users	Try
GET	getOrganizationFields	/organizationFields	Get all organization fields	Try
POST	addOrganizationField	/organizationFields	Add a new organization field	Try
DELETE	deleteOrganizationFields	/organizationFields	Delete multiple organization fields in bulk	Try
GET	getOrganizationField	/organizationFields/{id}	Get one organization field	Try
PUT	updateOrganizationField	/organizationFields/{id}	Update an organization field	Try
DELETE	deleteOrganizationField	/organizationFields/{id}	Delete an organization field	Try
GET	getOrganizationRelationships	/organizationRelationships	Get all relationships for organization	Try
POST	addOrganizationRelationship	/organizationRelationships	Create an organization relationship	Try
GET	getOrganizationRelationship	/organizationRelationships/{id}	Get one organization relationship	Try
PUT	updateOrganizationRelationship	/organizationRelationships/{id}	Update an organization relationship	Try
DELETE	deleteOrganizationRelationship	/organizationRelationships/{id}	Delete an organization relationship	Try
GET	getPermissionSets	/permissionSets	Get all permission sets	Try
GET	getPermissionSet	/permissionSets/{id}	Get one permission set	Try
GET	getPermissionSetAssignments	/permissionSets/{id}/assignments	List permission set assignments	Try
GET	getPersonChangelog	/persons/{id}/changelog	List updates about person field values	Try
GET	getPersonFiles	/persons/{id}/files	List files attached to a person	Try
GET	getPersonUpdates	/persons/{id}/flow	List updates about a person	Try
GET	getPersonFollowers	/persons/{id}/followers	List followers of a person	Try
POST	addPersonFollower	/persons/{id}/followers	Add a follower to a person	Try
DELETE	deletePersonFollower	/persons/{id}/followers/{follower_id}	Delete a follower from a person	Try
GET	getPersonMailMessages	/persons/{id}/mailMessages	List mail messages associated with a person	Try
PUT	mergePersons	/persons/{id}/merge	Merge two persons	Try
GET	getPersonUsers	/persons/{id}/permittedUsers	List permitted users	Try
POST	addPersonPicture	/persons/{id}/picture	Add person picture	Try
DELETE	deletePersonPicture	/persons/{id}/picture	Delete person picture	Try
GET	getPersonProducts	/persons/{id}/products	List products associated with a person	Try
GET	getPersonFields	/personFields	Get all person fields	Try
POST	addPersonField	/personFields	Add a new person field	Try
DELETE	deletePersonFields	/personFields	Delete multiple person fields in bulk	Try
GET	getPersonField	/personFields/{id}	Get one person field	Try
PUT	updatePersonField	/personFields/{id}	Update a person field	Try
DELETE	deletePersonField	/personFields/{id}	Delete a person field	Try
GET	getPipelineConversionStatistics	/pipelines/{id}/conversion_statistics	Get deals conversion rates in pipeline	Try
GET	getPipelineDeals	/pipelines/{id}/deals	Get deals in a pipeline	Try
GET	getPipelineMovementStatistics	/pipelines/{id}/movement_statistics	Get deals movements in pipeline	Try
GET	getProductDeals	/products/{id}/deals	Get deals where a product is attached to	Try
GET	getProductFiles	/products/{id}/files	List files attached to a product	Try
GET	getProductFollowers	/products/{id}/followers	List followers of a product	Try
POST	addProductFollower	/products/{id}/followers	Add a follower to a product	Try
DELETE	deleteProductFollower	/products/{id}/followers/{follower_id}	Delete a follower from a product	Try
GET	getProductUsers	/products/{id}/permittedUsers	List permitted users	Try
GET	getProductFields	/productFields	Get all product fields	Try
POST	addProductField	/productFields	Add a new product field	Try
DELETE	deleteProductFields	/productFields	Delete multiple product fields in bulk	Try
GET	getProductField	/productFields/{id}	Get one product field	Try
PUT	updateProductField	/productFields/{id}	Update a product field	Try
DELETE	deleteProductField	/productFields/{id}	Delete a product field	Try
GET	getProjects	/projects	Get all projects	Try
POST	addProject	/projects	Add a project	Try
GET	getProject	/projects/{id}	Get details of a project	Try
PUT	updateProject	/projects/{id}	Update a project	Try
DELETE	deleteProject	/projects/{id}	Delete a project	Try
POST	archiveProject	/projects/{id}/archive	Archive a project	Try
GET	getProjectPlan	/projects/{id}/plan	Returns project plan	Try
PUT	putProjectPlanActivity	/projects/{id}/plan/activities/{activityId}	Update activity in project plan	Try
PUT	putProjectPlanTask	/projects/{id}/plan/tasks/{taskId}	Update task in project plan	Try
GET	getProjectGroups	/projects/{id}/groups	Returns project groups	Try
GET	getProjectTasks	/projects/{id}/tasks	Returns project tasks	Try
GET	getProjectActivities	/projects/{id}/activities	Returns project activities	Try
GET	getProjectsBoards	/projects/boards	Get all project boards	Try
GET	getProjectsBoard	/projects/boards/{id}	Get details of a board	Try
GET	getProjectsPhases	/projects/phases	Get project phases	Try
GET	getProjectsPhase	/projects/phases/{id}	Get details of a phase	Try
GET	getProjectTemplates	/projectTemplates	Get all project templates	Try
GET	getProjectTemplate	/projectTemplates/{id}	Get details of a template	Try
GET	getRecents	/recents	Get recents	Try
GET	getRoles	/roles	Get all roles	Try
POST	addRole	/roles	Add a role	Try
GET	getRole	/roles/{id}	Get one role	Try
PUT	updateRole	/roles/{id}	Update role details	Try
DELETE	deleteRole	/roles/{id}	Delete a role	Try
GET	getRoleAssignments	/roles/{id}/assignments	List role assignments	Try
POST	addRoleAssignment	/roles/{id}/assignments	Add role assignment	Try
DELETE	deleteRoleAssignment	/roles/{id}/assignments	Delete a role assignment	Try
GET	getRoleSettings	/roles/{id}/settings	List role settings	Try
POST	addOrUpdateRoleSetting	/roles/{id}/settings	Add or update role setting	Try
GET	getRolePipelines	/roles/{id}/pipelines	List pipeline visibility for a role	Try
PUT	updateRolePipelines	/roles/{id}/pipelines	Update pipeline visibility for a role	Try
GET	getStageDeals	/stages/{id}/deals	Get deals in a stage	Try
GET	getTasks	/tasks	Get all tasks	Try
POST	addTask	/tasks	Add a task	Try
GET	getTask	/tasks/{id}	Get details of a task	Try
PUT	updateTask	/tasks/{id}	Update a task	Try
DELETE	deleteTask	/tasks/{id}	Delete a task	Try
GET	getUsers	/users	Get all users	Try
POST	addUser	/users	Add a new user	Try
GET	findUsersByName	/users/find	Find users by name	Try
GET	getCurrentUser	/users/me	Get current user data	Try
GET	getUser	/users/{id}	Get one user	Try
PUT	updateUser	/users/{id}	Update user details	Try
GET	getUserFollowers	/users/{id}/followers	List followers of a user	Try
GET	getUserPermissions	/users/{id}/permissions	List user permissions	Try
GET	getUserRoleAssignments	/users/{id}/roleAssignments	List role assignments	Try
GET	getUserRoleSettings	/users/{id}/roleSettings	List user role settings	Try
GET	getUserConnections	/userConnections	Get all user connections	Try
GET	getUserSettings	/userSettings	List settings of an authorized user	Try
GET	getWebhooks	/webhooks	Get all Webhooks	Try
POST	addWebhook	/webhooks	Create a new Webhook	Try
DELETE	deleteWebhook	/webhooks/{id}	Delete existing Webhook	Try