How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Pipedrive PersonFields API

Person fields represent the near-complete schema for a person in the context of the company of the authorized user. Each company can have a different schema for their persons, with various custom fields. In the context of using person fields as a schema for defining the data fields of a person, it must be kept in mind that some types of custom fields can have additional data fields which are not separate person fields per se. Such is the case with monetary, daterange and timerange fields – each of these fields will have one additional data field in addition to the one presented in the context of person fields. For example, if there is a monetary field with the key `ffk9s9` stored on the account, `ffk9s9` would hold the numeric value of the field, and `ffk9s9_currency` would hold the ISO currency code that goes along with the numeric value. To find out which data fields are available, fetch one person and list its keys.

Pipedrive PersonFields API is one of 48 APIs that Pipedrive publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include PersonFields. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 12 operations across 4 paths. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.pipedrive.com/v1.

12 operations 4 paths 0 schemas 4 DELETE3 GET2 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Server
https://api.pipedrive.com/v1
Authentication
HTTP Basic, API Key, OAuth 2.0
Resource Areas
1

Authentication & Security 3

Pipedrive PersonFields API declares 3 security schemes for authenticating requests. It accepts HTTP basic authentication (basic_authentication). An API key is passed in the header as x-api-token (api_key). It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 27 scopes.

  • basic_authentication — Base 64 encoded string containing the clientid and clientsecret values. The header value should be Basic .
  • oauth2 — For more information, see https://pipedrive.readme.io/docs/marketplace-oauth-authorization

Paths & Operations 12

Across 4 paths, the API surfaces 12 operations — 4 DELETE, 3 GET, 2 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

PersonFields 12

Person fields represent the near-complete schema for a person in the context of the company of the authorized user. Each company can have a different schema for their persons, wit…

GET
/personFields
Get all person fields
getPersonFields 2 params → 200
POST
/personFields
Add a new person field
addPersonField body → 200
DELETE
/personFields
Delete multiple person fields in bulk
deletePersonFields 1 param → 200
GET
/personFields/{id}
Get one person field
getPersonField 1 param → 200
DELETE
/personFields/{id}
Delete a person field
deletePersonField 1 param → 200
PUT
/personFields/{id}
Update a person field
updatePersonField 1 param body → 200
GET
/personFields/{field_code}
Get one person field
getPersonField 2 params → 200
PATCH
/personFields/{field_code}
Update one person field
updatePersonField 1 param body → 200
DELETE
/personFields/{field_code}
Delete one person field
deletePersonField 1 param → 200
POST
/personFields/{field_code}/options
Add person field options in bulk
addPersonFieldOptions 1 param body → 200
DELETE
/personFields/{field_code}/options
Delete person field options in bulk
deletePersonFieldOptions 1 param body → 200
PATCH
/personFields/{field_code}/options
Update person field options in bulk
updatePersonFieldOptions 1 param body → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pipedrive-personfields-api-openapi.yml Raw ↑

Other APIs Pipedrive publishes across the network.

Pipedrive Activities API
Pipedrive ActivityFields API
Pipedrive ActivityTypes API
Pipedrive Beta API
Pipedrive Billing API
Pipedrive CallLogs API
Pipedrive Channels API
Pipedrive Currencies API
Pipedrive DealFields API
Pipedrive DealInstallments API
Pipedrive DealProducts API
Pipedrive Deals API
Where this information came from

This is an independent, third-party profile of Pipedrive PersonFields API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.