API Structure & Access
Overview
This section will describe the structure, request methods, and access for working with our APIS.
We've organized our APIs around REST commands and use HTTP response codes to indicate successful API calls and those that produce errors. We return all API responses, including errors, as JSON objects.
Our APIs reside at api.peopledatalabs.com
. When making direct API requests in URL, you must do so over HTTPS. Calls made over standard HTTP will fail. API requests without proper Authentication (a valid API key) will also fail.
API Structure
{BaseURL}/{version}/{entity}/{endpoint}?{parameters}
- Base URL: https://api.peopledatalabs.com
- Version: version number
- All live endpoints operate on "v5"
- Entity: References the type of data to request
- Person or Company or IP
- Endpoint: The type of product to request
- Typically
enrich
orsearch
- Typically
- Parameters: Each endpoint has a set of required parameters
https://api.peopledatalabs.com/v5/person/enrich?api_key=XXXX&profile=linkedin.com/in/seanthorne
Methods
PDL support GET
requests for all endpoints and POST
for the following endpoints:
- Person Enrichment API
- Person Search API
- Company Search API
- Autocomplete API
- Cleaner APIs
- Job Title Enrichment API
Access
You can access our APIs via:
- Custom scripts in the language of your choice
- One of our SDKs
- Use our Postman Collection
Updated about 1 month ago