Input Parameters - Person Retrieve API
Detailed information on the input parameters for the Person Retrieve API
Required Parameters
person_id
person_id| Type | Description | Example |
|---|---|---|
String | The PDL Persistent ID for a record in our Person Dataset. | qEnOZ5Oh0poWnQ1luFBfVw_0000 |
When calling the Person Retrieve API in URL, you must specify this as part of the endpoint URL.
You must use a Persistent ID for the person_id. If the provided ID does not represent a record from our Person Dataset, then the Person Retrieve API will return a 404 Not Found error.
Using the
person_idParameter in URLWhen calling the Person Retrieve API in URL, you must pass the
person_idparameter as part of the endpoint path rather than as a URL parameter.For example, using the ID
qEnOZ5Oh0poWnQ1luFBfVw_0000:
- Correct:
v5/person/retrieve/qEnOZ5Oh0poWnQ1luFBfVw_0000- Incorrect:
v5/person/retrieve?person_id=qEnOZ5Oh0poWnQ1luFBfVw_0000
Optional Parameters
pretty
pretty| Type | Description | Default | Example |
|---|---|---|---|
Boolean | Whether the output should have human-readable indentation. | false | true |
api_key
api_key| Type | Description | Default | Example |
|---|---|---|---|
String | Your secret API key. |
Your API Key must be included in either the request header or the api_key parameter. For more information about request authentication, see the Authentication page.
filter_updated
filter_updated| Type | Description | Default | Example |
|---|---|---|---|
Enum (String) | Which Person Data field changes count as an updated record. | job_change |
Use this parameter to filter which changes to person records count as an update. If you include this parameter in your request, only changes to the parameter-specific fields will count as an update. If this parameter is not included in the request, any changes to the record (new data source, any field value change) will count as an update.
Supported Filters:
| Filter Name | Update Based On |
|---|---|
job_change | job_company_id or job_title |
Updated 4 months ago