Input Parameters - Person Retrieve API

Detailed information on the input parameters for the Person Retrieve API

Required Parameters

person_id

Parameter Name

Required

Description

Default

Example

person_id

Yes

The PDL Persistent ID for a record in our Person Dataset. When calling the Person Retrieve API in URL, you must specify this as part of the endpoint URL.

None

qEnOZ5Oh0poWnQ1luFBfVw_0000

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 not return a matching record.

📘

Using the person_id Parameter in URL

When calling the Person Retrieve API in URL, you must pass the person_id parameter 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

Parameter Name

Required

Description

Default

Example

pretty

No

Whether the output should have human-readable indentation.

False

True


api_key

Parameter Name

Required

Description

Default

Example

api_key

No

Your secret API key.

While we do not require this as part of the request parameters, if you do not provide it here, then you must provide it using an alternative means, such as in the headers using the x-api-key field. For more information, see the Authentication page.


Did this page help you?