Input Parameters - Person Retrieve API

Detailed information on the input parameters used 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. This must be specified as part of the endpoint url.

None

qEnOZ5Oh0poWnQ1luFBfVw_0000

The person_id must be a Persistent ID for a person profile record. If the provided ID does not represent a record from our Person Dataset then no matching record will be returned by the Person Retrieve API.

📘

Using the person_id parameter

The person_id parameter must be passed 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

Not required as part of the request parameters, but if not provided here, then it must be provided in the headers using the x-api-key field. For more information see the Authentication page.

<API_KEY>


Did this page help you?