Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,16 @@ The file format of it is based on [Keep a Changelog](http://keepachangelog.com/e
For public Changelog covering all changes done to Pipedrive’s API, webhooks and app extensions platforms, see [public Changelog](https://pipedrive.readme.io/docs/changelog) with discussion area in [Developers Community](https://devcommunity.pipedrive.com/c/documentation/changelog/19).

## [Unreleased]
### Added
- Added projects v2 API
- Added project boards v2 API
- Added project phases v2 API
- Added project tasks v2 API
- Added project search v2 API
- Added project templates v2 API
- Added project fields v2 API
- Added `include_option_labels` parameter for v2 GET deal, person and organization endpoints
- Added `include_labels` parameter to v2 GET deal, person, and organization endpoints

## [32.2.1] - 2026-04-20
### Changed
Expand Down
8 changes: 4 additions & 4 deletions docs/v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,10 +162,12 @@ ProductsApi | getProductDeals | **GET** /products/{id}/deals | Get deals where a
ProductsApi | getProductFiles | **GET** /products/{id}/files | List files attached to a product
ProductsApi | getProductFollowers | **GET** /products/{id}/followers | List followers of a product
ProductsApi | getProductUsers | **GET** /products/{id}/permittedUsers | List permitted users
ProjectBoardsApi | getProjectsBoard | **GET** /projects/boards/{id} | Get details of a board
ProjectBoardsApi | getProjectsBoards | **GET** /projects/boards | Get all project boards
ProjectPhasesApi | getProjectsPhase | **GET** /projects/phases/{id} | Get details of a phase
ProjectPhasesApi | getProjectsPhases | **GET** /projects/phases | Get project phases
ProjectTemplatesApi | getProjectTemplate | **GET** /projectTemplates/{id} | Get details of a template
ProjectTemplatesApi | getProjectTemplates | **GET** /projectTemplates | Get all project templates
ProjectTemplatesApi | getProjectsBoard | **GET** /projects/boards/{id} | Get details of a board
ProjectTemplatesApi | getProjectsPhase | **GET** /projects/phases/{id} | Get details of a phase
ProjectsApi | addProject | **POST** /projects | Add a project
ProjectsApi | archiveProject | **POST** /projects/{id}/archive | Archive a project
ProjectsApi | deleteProject | **DELETE** /projects/{id} | Delete a project
Expand All @@ -175,8 +177,6 @@ ProjectsApi | getProjectGroups | **GET** /projects/{id}/groups | Returns project
ProjectsApi | getProjectPlan | **GET** /projects/{id}/plan | Returns project plan
ProjectsApi | getProjectTasks | **GET** /projects/{id}/tasks | Returns project tasks
ProjectsApi | getProjects | **GET** /projects | Get all projects
ProjectsApi | getProjectsBoards | **GET** /projects/boards | Get all project boards
ProjectsApi | getProjectsPhases | **GET** /projects/phases | Get project phases
ProjectsApi | putProjectPlanActivity | **PUT** /projects/{id}/plan/activities/{activityId} | Update activity in project plan
ProjectsApi | putProjectPlanTask | **PUT** /projects/{id}/plan/tasks/{taskId} | Update task in project plan
ProjectsApi | updateProject | **PUT** /projects/{id} | Update a project
Expand Down
82 changes: 71 additions & 11 deletions docs/v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,30 @@ ActivitiesApi | getActivity | **GET** /activities/{id} | Get details of an activ
ActivitiesApi | updateActivity | **PATCH** /activities/{id} | Update an activity
ActivityFieldsApi | getActivityField | **GET** /activityFields/{field_code} | Get one activity field
ActivityFieldsApi | getActivityFields | **GET** /activityFields | Get all activity fields
BetaApi | addProjectBoard | **POST** /boards | Add a project board
BetaApi | addProjectField | **POST** /projectFields | Create one project field
BetaApi | addProjectFieldOptions | **POST** /projectFields/{field_code}/options | Add project field options in bulk
BetaApi | addProjectPhase | **POST** /phases | Add a project phase
BetaApi | addTask | **POST** /tasks | Add a task
BetaApi | deleteProjectBoard | **DELETE** /boards/{id} | Delete a project board
BetaApi | deleteProjectField | **DELETE** /projectFields/{field_code} | Delete one project field
BetaApi | deleteProjectFieldOptions | **DELETE** /projectFields/{field_code}/options | Delete project field options in bulk
BetaApi | deleteProjectPhase | **DELETE** /phases/{id} | Delete a project phase
BetaApi | deleteTask | **DELETE** /tasks/{id} | Delete a task
BetaApi | getProjectField | **GET** /projectFields/{field_code} | Get one project field
BetaApi | getProjectFields | **GET** /projectFields | Get all project fields
BetaApi | getProjectsBoard | **GET** /boards/{id} | Get details of a project board
BetaApi | getProjectsBoards | **GET** /boards | Get all project boards
BetaApi | getProjectsPhase | **GET** /phases/{id} | Get details of a project phase
BetaApi | getProjectsPhases | **GET** /phases | Get project phases
BetaApi | getTask | **GET** /tasks/{id} | Get details of a task
BetaApi | getTasks | **GET** /tasks | Get all tasks
BetaApi | searchProjects | **GET** /projects/search | Search projects
BetaApi | updateProjectBoard | **PATCH** /boards/{id} | Update a project board
BetaApi | updateProjectField | **PATCH** /projectFields/{field_code} | Update one project field
BetaApi | updateProjectFieldOptions | **PATCH** /projectFields/{field_code}/options | Update project field options in bulk
BetaApi | updateProjectPhase | **PATCH** /phases/{id} | Update a project phase
BetaApi | updateTask | **PATCH** /tasks/{id} | Update a task
DealFieldsApi | addDealField | **POST** /dealFields | Create one deal field
DealFieldsApi | addDealFieldOptions | **POST** /dealFields/{field_code}/options | Add deal field options in bulk
DealFieldsApi | deleteDealField | **DELETE** /dealFields/{field_code} | Delete one deal field
Expand All @@ -19,34 +43,34 @@ DealFieldsApi | getDealField | **GET** /dealFields/{field_code} | Get one deal f
DealFieldsApi | getDealFields | **GET** /dealFields | Get all deal fields
DealFieldsApi | updateDealField | **PATCH** /dealFields/{field_code} | Update one deal field
DealFieldsApi | updateDealFieldOptions | **PATCH** /dealFields/{field_code}/options | Update deal field options in bulk
DealInstallmentsApi | deleteInstallment | **DELETE** /deals/{id}/installments/{installment_id} | Delete an installment from a deal
DealInstallmentsApi | getInstallments | **GET** /deals/installments | List installments added to a list of deals
DealInstallmentsApi | postInstallment | **POST** /deals/{id}/installments | Add an installment to a deal
DealInstallmentsApi | updateInstallment | **PATCH** /deals/{id}/installments/{installment_id} | Update an installment added to a deal
DealProductsApi | addDealProduct | **POST** /deals/{id}/products | Add a product to a deal
DealProductsApi | addManyDealProducts | **POST** /deals/{id}/products/bulk | Add multiple products to a deal
DealProductsApi | deleteDealProduct | **DELETE** /deals/{id}/products/{product_attachment_id} | Delete an attached product from a deal
DealProductsApi | deleteManyDealProducts | **DELETE** /deals/{id}/products | Delete many products from a deal
DealProductsApi | getDealProducts | **GET** /deals/{id}/products | List products attached to a deal
DealProductsApi | getDealsProducts | **GET** /deals/products | Get deal products of several deals
DealProductsApi | updateDealProduct | **PATCH** /deals/{id}/products/{product_attachment_id} | Update the product attached to a deal
DealsApi | addDeal | **POST** /deals | Add a new deal
DealsApi | addDealFollower | **POST** /deals/{id}/followers | Add a follower to a deal
DealsApi | addDealProduct | **POST** /deals/{id}/products | Add a product to a deal
DealsApi | addManyDealProducts | **POST** /deals/{id}/products/bulk | Add multiple products to a deal
DealsApi | convertDealToLead | **POST** /deals/{id}/convert/lead | Convert a deal to a lead
DealsApi | deleteAdditionalDiscount | **DELETE** /deals/{id}/discounts/{discount_id} | Delete a discount from a deal
DealsApi | deleteDeal | **DELETE** /deals/{id} | Delete a deal
DealsApi | deleteDealFollower | **DELETE** /deals/{id}/followers/{follower_id} | Delete a follower from a deal
DealsApi | deleteDealProduct | **DELETE** /deals/{id}/products/{product_attachment_id} | Delete an attached product from a deal
DealsApi | deleteInstallment | **DELETE** /deals/{id}/installments/{installment_id} | Delete an installment from a deal
DealsApi | deleteManyDealProducts | **DELETE** /deals/{id}/products | Delete many products from a deal
DealsApi | getAdditionalDiscounts | **GET** /deals/{id}/discounts | List discounts added to a deal
DealsApi | getArchivedDeals | **GET** /deals/archived | Get all archived deals
DealsApi | getDeal | **GET** /deals/{id} | Get details of a deal
DealsApi | getDealConversionStatus | **GET** /deals/{id}/convert/status/{conversion_id} | Get Deal conversion status
DealsApi | getDealFollowers | **GET** /deals/{id}/followers | List followers of a deal
DealsApi | getDealFollowersChangelog | **GET** /deals/{id}/followers/changelog | List followers changelog of a deal
DealsApi | getDealProducts | **GET** /deals/{id}/products | List products attached to a deal
DealsApi | getDeals | **GET** /deals | Get all deals
DealsApi | getDealsProducts | **GET** /deals/products | Get deal products of several deals
DealsApi | getInstallments | **GET** /deals/installments | List installments added to a list of deals
DealsApi | postAdditionalDiscount | **POST** /deals/{id}/discounts | Add a discount to a deal
DealsApi | postInstallment | **POST** /deals/{id}/installments | Add an installment to a deal
DealsApi | searchDeals | **GET** /deals/search | Search deals
DealsApi | updateAdditionalDiscount | **PATCH** /deals/{id}/discounts/{discount_id} | Update a discount added to a deal
DealsApi | updateDeal | **PATCH** /deals/{id} | Update a deal
DealsApi | updateDealProduct | **PATCH** /deals/{id}/products/{product_attachment_id} | Update the product attached to a deal
DealsApi | updateInstallment | **PATCH** /deals/{id}/installments/{installment_id} | Update an installment added to a deal
ItemSearchApi | searchItem | **GET** /itemSearch | Perform a search from multiple item types
ItemSearchApi | searchItemByField | **GET** /itemSearch/field | Perform a search using a specific field from an item type
LeadsApi | convertLeadToDeal | **POST** /leads/{id}/convert/deal | Convert a lead to a deal
Expand Down Expand Up @@ -121,11 +145,46 @@ ProductsApi | updateProduct | **PATCH** /products/{id} | Update a product
ProductsApi | updateProductImage | **PUT** /products/{id}/images | Update an image for a product
ProductsApi | updateProductVariation | **PATCH** /products/{id}/variations/{product_variation_id} | Update a product variation
ProductsApi | uploadProductImage | **POST** /products/{id}/images | Upload an image for a product
ProjectBoardsApi | addProjectBoard | **POST** /boards | Add a project board
ProjectBoardsApi | deleteProjectBoard | **DELETE** /boards/{id} | Delete a project board
ProjectBoardsApi | getProjectsBoard | **GET** /boards/{id} | Get details of a project board
ProjectBoardsApi | getProjectsBoards | **GET** /boards | Get all project boards
ProjectBoardsApi | updateProjectBoard | **PATCH** /boards/{id} | Update a project board
ProjectFieldsApi | addProjectField | **POST** /projectFields | Create one project field
ProjectFieldsApi | addProjectFieldOptions | **POST** /projectFields/{field_code}/options | Add project field options in bulk
ProjectFieldsApi | deleteProjectField | **DELETE** /projectFields/{field_code} | Delete one project field
ProjectFieldsApi | deleteProjectFieldOptions | **DELETE** /projectFields/{field_code}/options | Delete project field options in bulk
ProjectFieldsApi | getProjectField | **GET** /projectFields/{field_code} | Get one project field
ProjectFieldsApi | getProjectFields | **GET** /projectFields | Get all project fields
ProjectFieldsApi | updateProjectField | **PATCH** /projectFields/{field_code} | Update one project field
ProjectFieldsApi | updateProjectFieldOptions | **PATCH** /projectFields/{field_code}/options | Update project field options in bulk
ProjectPhasesApi | addProjectPhase | **POST** /phases | Add a project phase
ProjectPhasesApi | deleteProjectPhase | **DELETE** /phases/{id} | Delete a project phase
ProjectPhasesApi | getProjectsPhase | **GET** /phases/{id} | Get details of a project phase
ProjectPhasesApi | getProjectsPhases | **GET** /phases | Get project phases
ProjectPhasesApi | updateProjectPhase | **PATCH** /phases/{id} | Update a project phase
ProjectTemplatesApi | getProjectTemplate | **GET** /projectTemplates/{id} | Get details of a template
ProjectTemplatesApi | getProjectTemplates | **GET** /projectTemplates | Get all project templates
ProjectsApi | addProject | **POST** /projects | Add a project
ProjectsApi | archiveProject | **POST** /projects/{id}/archive | Archive a project
ProjectsApi | deleteProject | **DELETE** /projects/{id} | Delete a project
ProjectsApi | getArchivedProjects | **GET** /projects/archived | Get all archived projects
ProjectsApi | getProject | **GET** /projects/{id} | Get details of a project
ProjectsApi | getProjectChangelog | **GET** /projects/{id}/changelog | List updates about project field values
ProjectsApi | getProjectUsers | **GET** /projects/{id}/permittedUsers | List permitted users
ProjectsApi | getProjects | **GET** /projects | Get all projects
ProjectsApi | searchProjects | **GET** /projects/search | Search projects
ProjectsApi | updateProject | **PATCH** /projects/{id} | Update a project
StagesApi | addStage | **POST** /stages | Add a new stage
StagesApi | deleteStage | **DELETE** /stages/{id} | Delete a stage
StagesApi | getStage | **GET** /stages/{id} | Get one stage
StagesApi | getStages | **GET** /stages | Get all stages
StagesApi | updateStage | **PATCH** /stages/{id} | Update stage details
TasksApi | addTask | **POST** /tasks | Add a task
TasksApi | deleteTask | **DELETE** /tasks/{id} | Delete a task
TasksApi | getTask | **GET** /tasks/{id} | Get details of a task
TasksApi | getTasks | **GET** /tasks | Get all tasks
TasksApi | updateTask | **PATCH** /tasks/{id} | Update a task
UsersApi | getUserFollowers | **GET** /users/{id}/followers | List followers of a user

## Documentation for Authorization
Expand Down Expand Up @@ -181,4 +240,5 @@ UsersApi | getUserFollowers | **GET** /users/{id}/followers | List followers of
- deal-fields:full: Create, read, update and delete deal fields
- product-fields:full: Create, read, update and delete product fields
- contact-fields:full: Create, read, update and delete person and organization fields
- project-fields:full: Create, read, update and delete project fields

2 changes: 2 additions & 0 deletions src/versions/v1/api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ export * from './api/persons-api';
export * from './api/pipelines-api';
export * from './api/product-fields-api';
export * from './api/products-api';
export * from './api/project-boards-api';
export * from './api/project-phases-api';
export * from './api/project-templates-api';
export * from './api/projects-api';
export * from './api/recents-api';
Expand Down
Loading
Loading