DealFields
Returns data about all deal fields.
Table-Specific Information
SELECT
The provider uses the Pipedrive API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the provider.
| Column | Supported Operators |
| Id | = |
For example, the following query is processed server-side:
SELECT * FROM DealFields WHERE Id = 12478
INSERT
Execute INSERT by specifying the Name and IconKey columns. You can also insert any columns that are not required.
For example:
INSERT INTO DealFields (Name, AddVisibleFlag, FieldType) VALUES ('test43', 'false', 'address')
UPDATE
Execute UPDATE by specifying the Id in the WHERE clause. All columns that are not read-only can be updated.
For example:
UPDATE DealFields SET Name = 'test44' WHERE Id = '12500'
DELETE
Execute DELETE by specifying the Id in the WHERE clause.
For example:
DELETE FROM DealFields WHERE Id = 12500
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
ID of the field. | |
| ActiveFlag | Boolean | True |
Whether the field is available in 'add new' modal or not (both in web and mobile app). The default value is true. | |
| AddTime | Datetime | True |
The date and time when the field was created. | |
| AddVisibleFlag | Boolean | False |
Whether the field is shown in the 'Add Deal' dialog in the Pipedrive web and mobile applications. | |
| BulkEditAllowed | Boolean | True |
Whether the field can be edited in bulk operations. | |
| DetailsVisibleFlag | Boolean | True |
Whether the field is visible on the deal detail view. | |
| EditFlag | Boolean | True |
Whether the field can be edited by the current user. | |
| FieldType | String | False |
Type of the field. The allowed values are address, date, daterange, double, enum, monetary, org, people, phone, set, text, time, timerange, user, varchar, varchar_auto, visible_to. | |
| FilteringAllowed | Boolean | True |
Whether the field can be used as a filter condition in deal list views. | |
| ImportantFlag | Boolean | True |
Whether the field is marked as important and highlighted in the deal detail view. | |
| IndexVisibleFlag | Boolean | True |
Whether the field is visible in the deal list view. | |
| Key [KEY] | String | True |
The unique machine-readable key that identifies the field within the Pipedrive API. | |
| LastUpdatedByUserId | String | True |
The ID of the user who last modified the field definition. | |
| MandatoryFlag | Boolean | True |
Whether the field is required when creating or updating a deal. | |
| Name | String | False |
Name of the field. | |
| Options | String | False |
The list of selectable options available for enum or set type fields. | |
| OrderNr | Integer | True |
The display order number of the field relative to other fields in the deal detail view. | |
| SearchableFlag | Boolean | True |
Whether the field is included in global search results within Pipedrive. | |
| SortableFlag | Boolean | True |
Whether the deal list view can be sorted by this field. | |
| UpdateTime | Datetime | True |
The date and time when the field definition was last modified. |