PersonFields

Returns data about all person fields, including both standard and custom field definitions for persons exposed through the Fields API v2.

Table-Specific Information

SELECT

The component 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 component.


Column	Supported Operators
FieldCode	=

For example, the following query is processed server-side:

SELECT * FROM PersonFields WHERE FieldCode = 'a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0'

INSERT

Execute INSERT by specifying the FieldName and FieldType columns. The Options column is required when FieldType is enum or set. You can also insert any columns that are not read-only. For example:

INSERT INTO PersonFields (FieldName, FieldType) VALUES ('Custom Note', 'varchar')

INSERT INTO PersonFields (FieldName, FieldType, Options) VALUES ('Lead Source', 'enum', '[{"label":"Inbound"},{"label":"Outbound"}]')

UPDATE

Execute UPDATE by specifying the FieldCode in the WHERE clause. All columns that are not read-only can be updated. The FieldType cannot be changed after creation. For example:

UPDATE PersonFields SET FieldName = 'Updated Name' WHERE FieldCode = 'a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0'

DELETE

Execute DELETE by specifying the FieldCode in the WHERE clause. For example:

DELETE FROM PersonFields WHERE FieldCode = 'a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0'

Columns


Name	Type	ReadOnly	References	Description
FieldCode [KEY]	String	True		The unique machine-readable code that identifies the field within the Pipedrive V2 API. Cannot be changed after creation.
FieldName	String	False		The display name of the person field.
Description	String	False		A human-readable description of the person field.
FieldType	String	False		The data type of the field. Cannot be changed after creation. The allowed values are address, date, daterange, double, enum, monetary, org, people, phone, set, text, time, timerange, user, varchar, varchar_auto.
Options	String	False		A JSON aggregate containing the selectable options for enum or set type fields, each with an id and label.
Subfields	String	True		A JSON aggregate containing the subfields that make up a composite field, such as the parts of an address field.
IsCustomField	Boolean	True		Indicates whether the field is a user-defined custom field rather than a standard Pipedrive field.
IsOptionalResponseField	Boolean	True		Indicates whether the field is returned only when explicitly requested through the include_fields parameter.
UiVisibilityAddVisibleFlag	Boolean	False		Whether the field is shown in the add person modal. Default is false.
UiVisibilityDetailsVisibleFlag	Boolean	False		Whether the field is shown in the person details view. Default is true.
UiVisibilityShowInAddDealDialogShow	Boolean	False		Whether the field is shown in the add deal dialog. Default is false.
UiVisibilityShowInAddDealDialogOrder	Integer	False		Display order in the add deal dialog.
ImportantFieldsEnabled	Boolean	False		Whether the field is marked as important.
ImportantFieldsStageIds	String	False		Array of deal stage IDs where this person field should be highlighted as important.
RequiredFieldsEnabled	Boolean	False		Whether the field is required. When false, the field is optional.