Beta
Beta endpoints are endpoints that may have changes without a regular 60-90 day notice period.
Get all project fields
Returns metadata about all project fields in the company.
Cost
10
Request
/api/v2/projectFields
Query parameters
limit
integer
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
cursor
string
For pagination, the marker (an opaque string value) representing the first item on the next page
Response
OK
Expand all
Copy code- true
- [ ... ]▶
- { ... }▶
Get one project field
Returns metadata about a specific project field.
Cost
1
Request
/api/v2/projectFields/{field_code}
Path parameters
field_code
string
required
The unique code identifying the field
Response
OK
Expand allCopy code- true
- { ... }▶
Get all project boards
Returns all active project boards.
Cost
10
Request
/api/v2/boards
Response
OK
Expand allCopy code- true
- [ ... ]▶
- null
Get details of a board
Returns the details of a specific project board.
Cost
10
Request
/api/v2/boards/{id}
Path parameters
id
integer
required
The ID of the project board
Response
OK
Expand allCopy code- true
- { ... }▶
Get project phases
Returns all active project phases under a specific board.
Cost
10
Request
/api/v2/phases
Query parameters
board_id
integer
required
The 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.
Cost
10
Request
/api/v2/phases/{id}
Path parameters
id
integer
required
The ID of the project phase
Response
OK
Expand allCopy code- true
- { ... }▶
Search projects
Searches all projects by title, description, notes and/or custom fields. This endpoint is a wrapper of /v1/itemSearch with a narrower OAuth scope. Found projects can be filtered by person ID or organization ID.
Cost
20
Request
/api/v2/projects/search
Query parameters
term
string
required
The search term to look for. Minimum 2 characters (or 1 if using exact_match). Please note that the search term has to be URL encoded.
fields
string
A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: address, varchar, text, varchar_auto, double, monetary and phone. Read more about searching by custom fields here.
Values
custom_fields
notes
title
description
exact_match
boolean
When enabled, only full exact matches against the given term are returned. It is not case sensitive.
person_id
integer
Will filter projects by the provided person ID
organization_id
integer
Will filter projects by the provided organization ID
limit
integer
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
cursor
string
For pagination, the marker (an opaque string value) representing the first item on the next page
Response
OK
Expand allCopy code- true
- { ... }▶
- { ... }▶
Create one project field
Creates a new project custom field.
Cost
5
Request
/api/v2/projectFields
Body parameters
application/json
field_name
string
required
Field name
field_type
string
required
The type of the field
| Value | Description |
|---|---|
varchar | Text (up to 255 characters) |
varchar_auto | Autocomplete text (up to 255 characters) |
text | Long text (up to 65k characters) |
double | Numeric value |
monetary | Monetary field (has a numeric value and a currency value) |
date | Date (format YYYY-MM-DD) |
set | Options field with a possibility of having multiple chosen options |
enum | Options field with a single possible chosen option |
user | User field (contains a user ID of another Pipedrive user) |
org | Organization field (contains an organization ID which is stored on the same account) |
people | Person field (contains a person ID which is stored on the same account) |
phone | Phone field (up to 255 numbers and/or characters) |
time | Time field (format HH:MM:SS) |
timerange | Time-range field (has a start time and end time value, both HH:MM:SS) |
daterange | Date-range field (has a start date and end date value, both YYYY-MM-DD) |
address | Address field |
Values
varchar
text
double
phone
date
daterange
time
timerange
set
enum
varchar_auto
address
monetary
org
people
user
options
array
Field options (required for enum and set field types)
label
string
required
The option label
ui_visibility
object
UI visibility settings for the field. Controls where the field appears in the Pipedrive web UI.
add_visible_flag
boolean
Whether the field is shown in the add project modal. Default is false.
details_visible_flag
boolean
Whether the field is shown in the project details view. Default is true.
Default
true
important_fields
object
Configuration for highlighting the field at specific stages.
enabled
boolean
Whether the field is marked as important. When false, the field is not highlighted. When true with empty stage_ids, the field is important everywhere. When true with specific stage_ids, the field is important only at those deal stages. Default is false.
stage_ids
array
Array of deal stage IDs where this project field should be highlighted as important. Must reference valid, active deal stages. Empty array when enabled is false.
Default
required_fields
object
Required fields configuration for marking the field as mandatory when interacted with in the Pipedrive web UI.
enabled
boolean
Whether the field is required. When false, the field is optional. When true, the field is required when creating or updating projects. Default is false.
Response
OK
Expand allCopy code- true
- { ... }▶
Add project field options in bulk
Adds new options to a project custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.
Cost
5
Request
/api/v2/projectFields/{field_code}/options
Path parameters
field_code
string
required
The unique code identifying the field
Body parameters
application/json
[ ]
array
Array of options to add. Each item must contain a label. At least one option is required.
label
string
required
The display label for the new option
Response
OK
Expand allCopy code- true
- [ ... ]▶
- null
Add a project board
Adds a new project board.
Cost
5
Request
/api/v2/boards
Body parameters
application/json
name
string
required
The name of the project board
order_nr
integer
The order of the board. Must be between 1 and the total number of boards + 1.
Response
OK
Expand allCopy code- true
- { ... }▶
Add a project phase
Adds a new project phase to a board.
Cost
5
Request
/api/v2/phases
Body parameters
application/json
name
string
required
The name of the project phase
board_id
integer
required
The ID of the project board to add the phase to
order_nr
integer
The order of the phase within its board. Must be between 1 and the total number of phases on the board + 1.
Response
OK
Expand allCopy code- true
- { ... }▶
Update one project field
Updates a project custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body.
Cost
5
Request
/api/v2/projectFields/{field_code}
Path parameters
field_code
string
required
The unique code identifying the field
Body parameters
application/json
field_name
string
Field name
ui_visibility
object
UI visibility settings for the field. Controls where the field appears in the Pipedrive web UI.
add_visible_flag
boolean
Whether the field is shown in the add project modal. Default is false.
details_visible_flag
boolean
Whether the field is shown in the project details view. Default is true.
Default
true
important_fields
object
Configuration for highlighting the field at specific stages.
enabled
boolean
Whether the field is marked as important. When false, the field is not highlighted. When true with empty stage_ids, the field is important everywhere. When true with specific stage_ids, the field is important only at those deal stages. Default is false.
stage_ids
array
Array of deal stage IDs where this project field should be highlighted as important. Must reference valid, active deal stages. Empty array when enabled is false.
Default
required_fields
object
Required fields configuration for marking the field as mandatory when interacted with in the Pipedrive web UI.
enabled
boolean
Whether the field is required. When false, the field is optional. When true, the field is required when creating or updating projects. Default is false.
Response
OK
Expand allCopy code- true
- { ... }▶
Update project field options in bulk
Updates existing options for a project custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options.
Cost
5
Request
/api/v2/projectFields/{field_code}/options
Path parameters
field_code
string
required
The unique code identifying the field
Body parameters
application/json
[ ]
array
Array of options to update. Each item must contain an ID and the updated label. At least one option is required. The entire request fails if any option does not exist.
id
integer
required
The unique identifier of the option to update
label
string
required
The new display label for the option
Response
OK
Expand allCopy code- true
- [ ... ]▶
- null
Update a project board
Updates the properties of a project board.
Cost
5
Request
/api/v2/boards/{id}
Path parameters
id
integer
required
The ID of the project board
Body parameters
application/json
name
string
The name of the project board
order_nr
integer
The order of the board. Must be between 1 and the total number of boards + 1.
Response
OK
Expand allCopy code- true
- { ... }▶
Update a project phase
Updates the properties of a project phase.
Cost
5
Request
/api/v2/phases/{id}
Path parameters
id
integer
required
The ID of the project phase
Body parameters
application/json
name
string
The name of the project phase
board_id
integer
The ID of the project board to add the phase to
order_nr
integer
The order of the phase within its board. Must be between 1 and the total number of phases on the board + 1.
Response
OK
Expand allCopy code- true
- { ... }▶
Delete one project field
Marks a custom field as deleted.
Cost
3
Request
/api/v2/projectFields/{field_code}
Path parameters
field_code
string
required
The unique code identifying the field
Response
OK
Expand allCopy code- true
- { ... }▶
Delete project field options in bulk
Removes existing options from a project custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options.
Cost
3
Request
/api/v2/projectFields/{field_code}/options
Path parameters
field_code
string
required
The unique code identifying the field
Body parameters
application/json
[ ]
array
Array of option IDs to delete. Each item must contain an ID of the option to delete. At least one option ID is required. The entire request fails if any option does not exist.
id
integer
required
The unique identifier of the option to delete
Response
OK
Expand allCopy code- true
- [ ... ]▶
- null
Delete a project board
Marks a project board as deleted.
Cost
3
Request
/api/v2/boards/{id}
Path parameters
id
integer
required
The ID of the project board
Response
OK
Expand allCopy code- true
- { ... }▶
Delete a project phase
Marks a project phase as deleted.
Cost
3
Request
/api/v2/phases/{id}
Path parameters
id
integer
required
The ID of the project phase
Response
OK
Expand allCopy code- true
- { ... }▶