Getting Started
In order to use our Person Retrieve API, you must have an active API key. You can look up your API key by logging into our self-serve dashboard and going to the API Keys section.Simple Example
As mentioned in the Overview, the Person Retrieve API is a way to directly look up records from our Person Dataset. In order to use the Person Retrieve API, you will need to know thePDL Person ID of the person that you want to look up. Here’s a quick example that demonstrates retrieving a record with aperson_id of qEnOZ5Oh0poWnQ1luFBfVw_0000:
Note: Common MistakesWhen using the Person Retrieve API, there are a couple common mistakes, such as:
- Using an ID that does not refer to a person profile (such as a company or school ID)
- Passing the ID as a URL parameter rather than part of the URL path. For example, using:
- Incorrect:
v5/person/retrieve?person_id=<PDL_PERSON_ID> - Correct:
v5/person/retrieve/<PDL_PERSON_ID>
- Incorrect:
person_id exists in our dataset:
JSON
data object, check out our Example Person Record.
If you don’t get this response, check out our Errors page for more information.
