openapi: 3.2.0
info:
title: People Data Labs Autocomplete Person API
description: People Data Labs (PDL) provides APIs for enriching and building people and company profiles at scale. The API offers person enrichment, person search, person identification, company enrichment, company search, IP enrichment, and job posting search across a dataset of professional profiles and organizations.
version: v5
contact:
name: People Data Labs Support
url: https://docs.peopledatalabs.com/docs/support
license:
name: People Data Labs Terms of Service
url: https://www.peopledatalabs.com/terms-of-service
servers:
- url: https://api.peopledatalabs.com/v5
description: People Data Labs production API
security:
- ApiKeyAuth: []
tags:
- name: Person
description: Person enrichment, search, and identification operations.
paths:
/person/enrich:
get:
tags:
- Person
summary: Enrich a person profile
description: Returns a single enriched person profile based on identifiers such as email, phone, profile URL, name, or company.
parameters:
- name: email
in: query
schema:
type: string
- name: phone
in: query
schema:
type: string
- name: profile
in: query
schema:
type: string
- name: first_name
in: query
schema:
type: string
- name: last_name
in: query
schema:
type: string
- name: company
in: query
schema:
type: string
- name: min_likelihood
in: query
schema:
type: integer
minimum: 0
maximum: 10
responses:
'200':
description: A single enriched person record.
/person/search:
get:
tags:
- Person
summary: Search for person profiles
description: Returns multiple person profiles matching an SQL or Elasticsearch query.
parameters:
- name: sql
in: query
schema:
type: string
- name: query
in: query
schema:
type: string
- name: size
in: query
schema:
type: integer
default: 1
maximum: 100
- name: from
in: query
schema:
type: integer
responses:
'200':
description: A list of matching person profiles.
/person/identify:
get:
tags:
- Person
summary: Identify a person
description: Returns a list of likely matching person profiles for the supplied identifiers, with match likelihood scores.
parameters:
- name: email
in: query
schema:
type: string
- name: phone
in: query
schema:
type: string
- name: first_name
in: query
schema:
type: string
- name: last_name
in: query
schema:
type: string
responses:
'200':
description: A list of likely matching person profiles.
/person/bulk:
post:
tags:
- Person
summary: Bulk person enrichment
description: Enrich multiple person profiles in a single request.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
requests:
type: array
items:
type: object
responses:
'200':
description: An array of enriched person records.
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-API-Key