openapi: 3.0.1 info: title: Pipedrive API v1 Activities ProjectFields API version: 1.0.0 description: 'Activities are appointments/tasks/events on a calendar that can be associated with a deal, a lead, a person and an organization. Activities can be of different type (such as call, meeting, lunch or a custom type - see ActivityTypes object) and can be assigned to a particular user. Note that activities can also be created without a specific date/time. ' servers: - url: https://api.pipedrive.com/v1 tags: - name: ProjectFields description: 'Project fields represent the schema for a project in the context of the company of the authorized user. Each company can have a different schema for their projects, with various custom fields. ' paths: /projectFields: get: summary: Get all project fields description: Returns metadata about all project fields in the company. x-token-cost: 10 operationId: getProjectFields tags: - ProjectFields security: - api_key: [] - oauth2: - projects:read - projects:full - project-fields:full parameters: - in: query name: limit description: 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. schema: type: integer example: 100 - in: query name: cursor required: false schema: type: string description: For pagination, the marker (an opaque string value) representing the first item on the next page responses: '200': description: Get all project fields content: application/json: schema: type: object properties: success: type: boolean description: Whether the request was successful data: type: array items: type: object required: - field_name - field_code - field_type - is_custom_field - is_optional_response_field properties: field_name: type: string description: The display name/label of the field field_code: type: string description: The unique identifier for the field (40-character hash for custom fields) field_type: type: string description: The type of the field enum: - int - double - boolean - varchar - text - phone - varchar_options - varchar_auto - date - daterange - time - timerange - enum - set - address - monetary - deal - deals - lead - org - people - project - stage - user - activity - json - picture - status - visible_to - price_list - billing_frequency - projects_board - projects_phase options: type: array nullable: true description: Array of available options for enum/set fields, null for other field types items: type: object properties: id: type: integer description: The option ID label: type: string description: The option display label color: type: string nullable: true description: Optional color code for the option update_time: type: string format: date-time nullable: true description: When the option was last updated add_time: type: string format: date-time nullable: true description: When the option was created subfields: type: array nullable: true description: Array of subfields for complex field types (address, monetary), null for simple field types items: type: object properties: field_code: type: string description: The subfield identifier field_name: type: string description: The subfield display name field_type: type: string description: The subfield type is_custom_field: type: boolean description: Whether this is a user-created custom field is_optional_response_field: type: boolean description: Whether this field is not returned by default in entity responses ui_visibility: type: object description: UI visibility settings (only included when requested via include_fields parameter) properties: add_visible_flag: type: boolean description: Whether the field is shown in the add modal details_visible_flag: type: boolean description: Whether the field is shown in the details view important_fields: type: object description: Important fields configuration properties: enabled: type: boolean description: Whether the field is marked as important stage_ids: type: array items: type: integer description: Array of deal stage IDs where the field is important required_fields: type: object description: Required fields configuration properties: enabled: type: boolean description: Whether the field is required additional_data: type: object properties: next_cursor: type: string nullable: true description: Base64url-encoded cursor for fetching the next page of results, null if no more pages example: success: true data: - field_name: Project Name field_code: name field_type: varchar options: null subfields: null is_custom_field: false is_optional_response_field: false ui_visibility: add_visible_flag: true details_visible_flag: true important_fields: enabled: false stage_ids: [] required_fields: enabled: true - field_name: Category field_code: 40characterhashforcustomfieldidentifier field_type: enum options: - id: 1 label: Internal - id: 2 label: External - id: 3 label: Research subfields: null is_custom_field: true is_optional_response_field: false ui_visibility: add_visible_flag: true details_visible_flag: true important_fields: enabled: false stage_ids: [] required_fields: enabled: false additional_data: next_cursor: eyJmaWVsZCI6ImlkIiwiZmllbGRWYWx1ZSI6Nywic29ydERpcmVjdGlvbiI6ImFzYyIsImlkIjo3fQ post: summary: Create one project field description: Creates a new project custom field. x-token-cost: 5 operationId: addProjectField tags: - ProjectFields security: - api_key: [] - oauth2: - project-fields:full requestBody: required: true content: application/json: schema: type: object required: - field_name - field_type properties: field_name: type: string minLength: 1 maxLength: 255 description: Field name field_type: type: string description: The type of the field
ValueDescription
`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
enum: - varchar - text - double - phone - date - daterange - time - timerange - set - enum - varchar_auto - address - monetary - org - people - user options: type: array description: Field options (required for enum and set field types) items: type: object required: - label properties: label: type: string description: The option label ui_visibility: type: object description: UI visibility settings for the field. Controls where the field appears in the Pipedrive web UI. additionalProperties: true properties: add_visible_flag: type: boolean description: Whether the field is shown in the add project modal. Default is false. default: false details_visible_flag: type: boolean description: Whether the field is shown in the project details view. Default is true. default: true important_fields: type: object description: Configuration for highlighting the field at specific stages. additionalProperties: true properties: enabled: type: boolean description: 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. default: false stage_ids: type: array items: type: integer description: 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: type: object description: Required fields configuration for marking the field as mandatory when interacted with in the Pipedrive web UI. additionalProperties: true properties: enabled: type: boolean description: 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. default: false responses: '200': description: Create one project field content: application/json: schema: type: object properties: success: type: boolean description: Whether the request was successful data: type: object required: - field_name - field_code - field_type - is_custom_field - is_optional_response_field properties: field_name: type: string description: The display name/label of the field field_code: type: string description: The unique identifier for the field (40-character hash for custom fields) field_type: type: string description: The type of the field enum: - int - double - boolean - varchar - text - phone - varchar_options - varchar_auto - date - daterange - time - timerange - enum - set - address - monetary - deal - deals - lead - org - people - project - stage - user - activity - json - picture - status - visible_to - price_list - billing_frequency - projects_board - projects_phase options: type: array nullable: true description: Array of available options for enum/set fields, null for other field types items: type: object properties: id: type: integer description: The option ID label: type: string description: The option display label color: type: string nullable: true description: Optional color code for the option update_time: type: string format: date-time nullable: true description: When the option was last updated add_time: type: string format: date-time nullable: true description: When the option was created subfields: type: array nullable: true description: Array of subfields for complex field types (address, monetary), null for simple field types items: type: object properties: field_code: type: string description: The subfield identifier field_name: type: string description: The subfield display name field_type: type: string description: The subfield type is_custom_field: type: boolean description: Whether this is a user-created custom field is_optional_response_field: type: boolean description: Whether this field is not returned by default in entity responses ui_visibility: type: object description: UI visibility settings (only included when requested via include_fields parameter) properties: add_visible_flag: type: boolean description: Whether the field is shown in the add modal details_visible_flag: type: boolean description: Whether the field is shown in the details view important_fields: type: object description: Important fields configuration properties: enabled: type: boolean description: Whether the field is marked as important stage_ids: type: array items: type: integer description: Array of deal stage IDs where the field is important required_fields: type: object description: Required fields configuration properties: enabled: type: boolean description: Whether the field is required example: success: true data: field_name: Category field_code: 946947d1b02fd3ef20798d6112ec5d895a686a21 field_type: enum options: - id: 1 label: Internal - id: 2 label: External - id: 3 label: Research subfields: null is_custom_field: true is_optional_response_field: false ui_visibility: add_visible_flag: true details_visible_flag: true important_fields: enabled: false stage_ids: [] required_fields: enabled: false /projectFields/{field_code}: get: summary: Get one project field description: Returns metadata about a specific project field. x-token-cost: 1 operationId: getProjectField tags: - ProjectFields security: - api_key: [] - oauth2: - projects:read - projects:full - project-fields:full parameters: - in: path name: field_code description: The unique code identifying the field required: true schema: type: string responses: '200': description: Get one project field content: application/json: schema: type: object properties: success: type: boolean description: Whether the request was successful data: type: object required: - field_name - field_code - field_type - is_custom_field - is_optional_response_field properties: field_name: type: string description: The display name/label of the field field_code: type: string description: The unique identifier for the field (40-character hash for custom fields) field_type: type: string description: The type of the field enum: - int - double - boolean - varchar - text - phone - varchar_options - varchar_auto - date - daterange - time - timerange - enum - set - address - monetary - deal - deals - lead - org - people - project - stage - user - activity - json - picture - status - visible_to - price_list - billing_frequency - projects_board - projects_phase options: type: array nullable: true description: Array of available options for enum/set fields, null for other field types items: type: object properties: id: type: integer description: The option ID label: type: string description: The option display label color: type: string nullable: true description: Optional color code for the option update_time: type: string format: date-time nullable: true description: When the option was last updated add_time: type: string format: date-time nullable: true description: When the option was created subfields: type: array nullable: true description: Array of subfields for complex field types (address, monetary), null for simple field types items: type: object properties: field_code: type: string description: The subfield identifier field_name: type: string description: The subfield display name field_type: type: string description: The subfield type is_custom_field: type: boolean description: Whether this is a user-created custom field is_optional_response_field: type: boolean description: Whether this field is not returned by default in entity responses ui_visibility: type: object description: UI visibility settings (only included when requested via include_fields parameter) properties: add_visible_flag: type: boolean description: Whether the field is shown in the add modal details_visible_flag: type: boolean description: Whether the field is shown in the details view important_fields: type: object description: Important fields configuration properties: enabled: type: boolean description: Whether the field is marked as important stage_ids: type: array items: type: integer description: Array of deal stage IDs where the field is important required_fields: type: object description: Required fields configuration properties: enabled: type: boolean description: Whether the field is required example: success: true data: field_name: Project Name field_code: name field_type: varchar options: null subfields: null is_custom_field: false is_optional_response_field: false ui_visibility: add_visible_flag: true details_visible_flag: true important_fields: enabled: false stage_ids: [] required_fields: enabled: true patch: summary: Update one project field description: 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. x-token-cost: 5 operationId: updateProjectField tags: - ProjectFields security: - api_key: [] - oauth2: - project-fields:full parameters: - in: path name: field_code description: The unique code identifying the field required: true schema: type: string requestBody: required: true content: application/json: schema: type: object minProperties: 1 properties: field_name: type: string minLength: 1 maxLength: 255 description: Field name ui_visibility: type: object description: UI visibility settings for the field. Controls where the field appears in the Pipedrive web UI. additionalProperties: true properties: add_visible_flag: type: boolean description: Whether the field is shown in the add project modal. Default is false. default: false details_visible_flag: type: boolean description: Whether the field is shown in the project details view. Default is true. default: true important_fields: type: object description: Configuration for highlighting the field at specific stages. additionalProperties: true properties: enabled: type: boolean description: 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. default: false stage_ids: type: array items: type: integer description: 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: type: object description: Required fields configuration for marking the field as mandatory when interacted with in the Pipedrive web UI. additionalProperties: true properties: enabled: type: boolean description: 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. default: false responses: '200': description: Get one project field content: application/json: schema: type: object properties: success: type: boolean description: Whether the request was successful data: type: object required: - field_name - field_code - field_type - is_custom_field - is_optional_response_field properties: field_name: type: string description: The display name/label of the field field_code: type: string description: The unique identifier for the field (40-character hash for custom fields) field_type: type: string description: The type of the field enum: - int - double - boolean - varchar - text - phone - varchar_options - varchar_auto - date - daterange - time - timerange - enum - set - address - monetary - deal - deals - lead - org - people - project - stage - user - activity - json - picture - status - visible_to - price_list - billing_frequency - projects_board - projects_phase options: type: array nullable: true description: Array of available options for enum/set fields, null for other field types items: type: object properties: id: type: integer description: The option ID label: type: string description: The option display label color: type: string nullable: true description: Optional color code for the option update_time: type: string format: date-time nullable: true description: When the option was last updated add_time: type: string format: date-time nullable: true description: When the option was created subfields: type: array nullable: true description: Array of subfields for complex field types (address, monetary), null for simple field types items: type: object properties: field_code: type: string description: The subfield identifier field_name: type: string description: The subfield display name field_type: type: string description: The subfield type is_custom_field: type: boolean description: Whether this is a user-created custom field is_optional_response_field: type: boolean description: Whether this field is not returned by default in entity responses ui_visibility: type: object description: UI visibility settings (only included when requested via include_fields parameter) properties: add_visible_flag: type: boolean description: Whether the field is shown in the add modal details_visible_flag: type: boolean description: Whether the field is shown in the details view important_fields: type: object description: Important fields configuration properties: enabled: type: boolean description: Whether the field is marked as important stage_ids: type: array items: type: integer description: Array of deal stage IDs where the field is important required_fields: type: object description: Required fields configuration properties: enabled: type: boolean description: Whether the field is required example: success: true data: field_name: Project Name field_code: name field_type: varchar options: null subfields: null is_custom_field: false is_optional_response_field: false ui_visibility: add_visible_flag: true details_visible_flag: true important_fields: enabled: false stage_ids: [] required_fields: enabled: true delete: summary: Delete one project field description: Marks a custom field as deleted. x-token-cost: 3 operationId: deleteProjectField tags: - ProjectFields security: - api_key: [] - oauth2: - project-fields:full parameters: - in: path name: field_code description: The unique code identifying the field required: true schema: type: string responses: '200': description: Delete one project field content: application/json: schema: type: object properties: success: type: boolean description: Whether the request was successful data: type: object required: - field_name - field_code - field_type - is_custom_field - is_optional_response_field properties: field_name: type: string description: The display name/label of the field field_code: type: string description: The unique identifier for the field (40-character hash for custom fields) field_type: type: string description: The type of the field options: type: array nullable: true description: Array of available options for enum/set fields, null for other field types items: type: object subfields: type: array nullable: true description: Array of subfields for complex field types, null for simple field types items: type: object is_custom_field: type: boolean description: Whether this is a user-created custom field is_optional_response_field: type: boolean description: Whether this field is not returned by default in entity responses example: success: true data: field_name: Custom text field field_code: 946947d1b02fd3ef20798d6112ec5d895a686a21 field_type: varchar options: null subfields: null is_custom_field: true is_optional_response_field: false /projectFields/{field_code}/options: post: summary: Add project field options in bulk description: 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. x-token-cost: 5 operationId: addProjectFieldOptions tags: - ProjectFields security: - api_key: [] - oauth2: - project-fields:full parameters: - in: path name: field_code description: The unique code identifying the field required: true schema: type: string requestBody: required: true content: application/json: schema: type: array description: Array of options to add. Each item must contain a label. At least one option is required. items: type: object required: - label properties: label: type: string minLength: 1 maxLength: 255 description: The display label for the new option responses: '200': description: Field options operation result content: application/json: schema: type: object properties: success: type: boolean data: type: array items: type: object required: - id - label properties: id: type: integer description: The unique identifier of the option label: type: string description: The display label of the option additional_data: type: object nullable: true example: success: true data: - id: 4 label: Research & Development additional_data: null delete: summary: Delete project field options in bulk description: 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. x-token-cost: 3 operationId: deleteProjectFieldOptions tags: - ProjectFields security: - api_key: [] - oauth2: - project-fields:full parameters: - in: path name: field_code description: The unique code identifying the field required: true schema: type: string requestBody: required: true content: application/json: schema: type: array description: 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. items: type: object required: - id properties: id: type: integer description: The unique identifier of the option to delete responses: '200': description: Field options operation result content: application/json: schema: type: object properties: success: type: boolean data: type: array items: type: object required: - id - label properties: id: type: integer description: The unique identifier of the option label: type: string description: The display label of the option additional_data: type: object nullable: true example: success: true data: - id: 4 label: Research & Development additional_data: null patch: summary: Update project field options in bulk description: 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. x-token-cost: 5 operationId: updateProjectFieldOptions tags: - ProjectFields security: - api_key: [] - oauth2: - project-fields:full parameters: - in: path name: field_code description: The unique code identifying the field required: true schema: type: string requestBody: required: true content: application/json: schema: type: array description: 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. items: type: object required: - id - label properties: id: type: integer description: The unique identifier of the option to update label: type: string minLength: 1 maxLength: 255 description: The new display label for the option responses: '200': description: Field options operation result content: application/json: schema: type: object properties: success: type: boolean data: type: array items: type: object required: - id - label properties: id: type: integer description: The unique identifier of the option label: type: string description: The display label of the option additional_data: type: object nullable: true example: success: true data: - id: 4 label: Research & Development additional_data: null components: securitySchemes: basic_authentication: type: http scheme: basic description: Base 64 encoded string containing the `client_id` and `client_secret` values. The header value should be `Basic `. api_key: type: apiKey name: x-api-token in: header oauth2: type: oauth2 description: For more information, see https://pipedrive.readme.io/docs/marketplace-oauth-authorization flows: authorizationCode: authorizationUrl: https://oauth.pipedrive.com/oauth/authorize tokenUrl: https://oauth.pipedrive.com/oauth/token refreshUrl: https://oauth.pipedrive.com/oauth/token scopes: base: Read settings of the authorized user and currencies in an account deals:read: Read most of the data about deals and related entities - deal fields, products, followers, participants; all notes, files, filters, pipelines, stages, and statistics. Does not include access to activities (except the last and next activity related to a deal) deals:full: Create, read, update and delete deals, its participants and followers; all files, notes, and filters. It also includes read access to deal fields, pipelines, stages, and statistics. Does not include access to activities (except the last and next activity related to a deal) mail:read: Read mail threads and messages mail:full: Read, update and delete mail threads. Also grants read access to mail messages activities:read: Read activities, its fields and types; all files and filters activities:full: Create, read, update and delete activities and all files and filters. Also includes read access to activity fields and types contacts:read: Read the data about persons and organizations, their related fields and followers; also all notes, files, filters contacts:full: Create, read, update and delete persons and organizations and their followers; all notes, files, filters. Also grants read access to contacts-related fields products:read: Read products, its fields, files, followers and products connected to a deal products:full: Create, read, update and delete products and its fields; add products to deals 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 projects:read: Read projects and its fields, tasks and project templates projects:full: Create, read, update and delete projects and its fields; add projects templates and project related tasks users:read: Read data about users (people with access to a Pipedrive account), their permissions, roles and followers recents:read: Read all recent changes occurred in an account. Includes data about activities, activity types, deals, files, filters, notes, persons, organizations, pipelines, stages, products and users search:read: Search across the account for deals, persons, organizations, files and products, and see details about the returned results admin: Allows to do many things that an administrator can do in a Pipedrive company account - create, read, update and delete pipelines and its stages; deal, person and organization fields; activity types; users and permissions, etc. It also allows the app to create webhooks and fetch and delete webhooks that are created by the app leads:read: Read data about leads and lead labels leads:full: Create, read, update and delete leads and lead labels phone-integration: Enables advanced call integration features like logging call duration and other metadata, and play call recordings inside Pipedrive goals:read: Read data on all goals goals:full: Create, read, update and delete goals video-calls: Allows application to register as a video call integration provider and create conference links messengers-integration: Allows application to register as a messengers integration provider and allows them to deliver incoming messages and their statuses