Projects BETA
Projects represent ongoing, completed or canceled projects attached to an organization, person or to deals. Each project has an owner and must be placed in a phase. Each project consists of standard data fields but can also contain a number of custom fields. The custom fields can be recognized by long hashes as keys.
Get all projects
Returns all projects. This is a cursor-paginated endpoint. For more information, please refer to our documentation on pagination.
Request
/v1/projects
Query parameters
cursor
string
For pagination, the marker (an opaque string value) representing the first item on the next page
limit
integer
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
filter_id
integer
The ID of the filter to use
status
string
If supplied, includes only projects with the specified statuses. Possible values are open, completed, canceled and deleted. By default deleted projects are not returned.
phase_id
integer
If supplied, only projects in specified phase are returned
include_archived
boolean
If supplied with true then archived projects are also included in the response. By default only not archived projects are returned.
Response
OK
Expand all
Copy code- true
- [ ... ]▶
- { ... }▶
Get details of a project
Returns the details of a specific project. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the key value of project fields.
Request
/v1/projects/{id}
Path parameters
id
integer
required
The ID of the project
Response
OK
Expand allCopy code- true
- { ... }▶
- null
Returns project plan
Returns information about items in a project plan. Items consists of tasks and activities and are linked to specific project phase and group.
Request
/v1/projects/{id}/plan
Path parameters
id
integer
required
The ID of the project
Response
OK
Expand allCopy code- true
- [ ... ]▶
- null
Returns project groups
Returns all active groups under a specific project.
Request
/v1/projects/{id}/groups
Path parameters
id
integer
required
The ID of the project
Response
OK
Expand allCopy code- true
- [ ... ]▶
- null
Returns project tasks
Returns tasks linked to a specific project.
Request
/v1/projects/{id}/tasks
Path parameters
id
integer
required
The ID of the project
Response
OK
Expand allCopy code- true
- [ ... ]▶
- { ... }▶
Returns project activities
Returns activities linked to a specific project.
Request
/v1/projects/{id}/activities
Path parameters
id
integer
required
The ID of the project
Response
OK
Expand allCopy code- true
- [ ... ]▶
- { ... }▶
Get all project boards
Returns all projects boards that are not deleted.
Request
/v1/projects/boards
Response
OK
Expand allCopy code- true
- [ ... ]▶
- null
Get details of a board
Returns the details of a specific project board.
Request
/v1/projects/boards/{id}
Path parameters
id
integer
required
The ID of the project board
Response
OK
Expand allCopy code- true
- { ... }▶
- null
Get project phases
Returns all active project phases under a specific board.
Request
/v1/projects/phases
Query parameters
board_id
integer
required
ID of the board for which phases are requested
Response
OK
Expand allCopy code- true
- [ ... ]▶
- null
Get details of a phase
Returns the details of a specific project phase.
Request
/v1/projects/phases/{id}
Path parameters
id
integer
required
The ID of the project phase
Response
OK
Expand allCopy code- true
- { ... }▶
- null
Add a project
Adds a new project. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys.
Request
/v1/projects
Body parameters
application/json
title
string
required
The title of the project
board_id
number
required
The ID of a project board
phase_id
number
required
The ID of a phase on a project board
description
string
The description of the project
status
string
The status of the project
owner_id
number
The ID of a project owner
start_date
string
The start date of the project. Format: YYYY-MM-DD.
Format
date
end_date
string
The end date of the project. Format: YYYY-MM-DD.
Format
date
deal_ids
array
An array of IDs of the deals this project is associated with
org_id
number
The ID of the organization this project is associated with
person_id
number
The ID of the person this project is associated with
labels
array
An array of IDs of the labels this project has
template_id
number
The ID of the template the project will be based on
Response
Created
Expand allCopy code- true
- { ... }▶
- null
Archive a project
Archives a project.
Request
/v1/projects/{id}/archive
Path parameters
id
integer
required
The ID of the project
Response
OK
Expand allCopy code- true
- { ... }▶
- null
Update a project
Updates a project.
Request
/v1/projects/{id}
Path parameters
id
integer
required
The ID of the project
Body parameters
application/json
title
string
The title of the project
board_id
number
The ID of the board this project is associated with
phase_id
number
The ID of the phase this project is associated with
description
string
The description of the project
status
string
The status of the project
owner_id
number
The ID of a project owner
start_date
string
The start date of the project. Format: YYYY-MM-DD.
Format
date
end_date
string
The end date of the project. Format: YYYY-MM-DD.
Format
date
deal_ids
array
An array of IDs of the deals this project is associated with
org_id
number
The ID of the organization this project is associated with
person_id
number
The ID of the person this project is associated with
labels
array
An array of IDs of the labels this project has
Response
OK
Expand allCopy code- true
- { ... }▶
- null
Update activity in project plan
Updates an activity phase or group in a project.
Request
/v1/projects/{id}/plan/activities/{activityId}
Path parameters
id
integer
required
The ID of the project
activityId
integer
required
The ID of the activity
Body parameters
application/json
phase_id
number
The ID of a phase on a project board
group_id
number
The ID of a group on a project board
Response
OK
Expand allCopy code- true
- { ... }▶
- null
Update task in project plan
Updates a task phase or group in a project.
Request
/v1/projects/{id}/plan/tasks/{taskId}
Path parameters
id
integer
required
The ID of the project
taskId
integer
required
The ID of the task
Body parameters
application/json
phase_id
number
The ID of a phase on a project board
group_id
number
The ID of a group on a project board
Response
OK
Expand allCopy code- true
- { ... }▶
- null
Delete a project
Marks a project as deleted.
Request
/v1/projects/{id}
Path parameters
id
integer
required
The ID of the project
Response
OK
Expand allCopy code- true
- { ... }▶
- null