> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# People Data Labs

> PeopleDataLabs provides B2B data enrichment and identity resolution, empowering organizations to build enriched user profiles and validate customer information

![People Data Labs logo](https://mintcdn.com/composio-preview/gqjBKmmJCINafaiK/images/toolkits/peopledatalabs.svg?fit=max\&auto=format\&n=gqjBKmmJCINafaiK\&q=85\&s=f4ce846acb232c56e9ce94fdf8c34a70)

* **Category:** people & contact data
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 27
* **Triggers:** 0
* **Slug:** `PEOPLEDATALABS`
* **Version:** 20261101\_00
* **Instant:** Supported on the latest version. Support varies by tool.

## Tools

> [accordion] Bulk Retrieve Persons
>
> **Slug:** `PEOPLEDATALABS_BULK_RETRIEVE_PERSONS`
>
> Retrieve up to 100 People Data Labs person records by persistent ID.
>
> #### Input Parameters
>
> **pretty** `boolean`
>
> Whether the provider should format its JSON response for readability.
>
> **requests** `array` *required*
>
> Between 1 and 100 person retrieval requests.
>
> **required** `string`
>
> Boolean expression of person fields required in a successful result.
>
> **titlecase** `boolean`
>
> Whether to title-case person data in successful results.
>
> **data\_include** `string`
>
> Comma-separated person fields to include, or fields prefixed with '-' to exclude.
>
> **filter\_updated** `string`
>
> Return people only when one of these fields was updated; multiple values are comma-separated on the wire.
>
> **min\_likelihood** `integer`
>
> Minimum likelihood score, from 1 through 10, required for a match.
>
> **include\_if\_matched** `boolean`
>
> Whether successful results should identify fields matched by the provider.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Clean company data
>
> **Slug:** `PEOPLEDATALABS_CLEAN_COMPANY_DATA`
>
> Cleans and standardizes company information based on a name, website, or profile URL; providing at least one of these inputs is highly recommended for meaningful results.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0 per request
>
> #### Input Parameters
>
> **name** `string`
>
> The company's current or known name. At least one of 'name', 'website', or 'profile' must be provided.
>
> **pretty** `boolean`
>
> If true, formats the JSON response with human-readable indentation.
>
> **profile** `string`
>
> The company's social media profile URL (e.g., LinkedIn, Twitter, Facebook). At least one of 'name', 'website', or 'profile' must be provided.
>
> **website** `string`
>
> The company's website URL. At least one of 'name', 'website', or 'profile' must be provided.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Clean company data (POST)
>
> **Slug:** `PEOPLEDATALABS_CLEAN_COMPANY_POST`
>
> Tool to clean and standardize company data using POST method. Use when you need to standardize company information by providing company name, website, or social profile. Returns standardized company information including name, website, LinkedIn profile, and other company identifiers.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0 per request
>
> #### Input Parameters
>
> **name** `string`
>
> The name of the company. At least one of 'name', 'website', or 'profile' must be provided.
>
> **pretty** `boolean`
>
> Whether the output should have human-readable indentation.
>
> **profile** `string`
>
> A social profile used by the company (e.g. LinkedIn/Facebook/Twitter). At least one of 'name', 'website', or 'profile' must be provided.
>
> **website** `string`
>
> A website the company uses. At least one of 'name', 'website', or 'profile' must be provided.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Clean location data
>
> **Slug:** `PEOPLEDATALABS_CLEAN_LOCATION_DATA`
>
> Cleans and standardizes a raw, unformatted location string into a structured representation, provided the input is a recognizable geographical place.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0 per request
>
> #### Input Parameters
>
> **location** `string` *required*
>
> The raw, unformatted location string to be cleaned and standardized. This can be a full address, a city/state pair, or just a place name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Clean location data (POST)
>
> **Slug:** `PEOPLEDATALABS_CLEAN_LOCATION_POST`
>
> Tool to clean and standardize location data using POST method. Use when you need to normalize raw location strings into structured location information including city, region, and country.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0 per request
>
> #### Input Parameters
>
> **pretty** `boolean`
>
> Whether the output should have human-readable indentation
>
> **location** `string` *required*
>
> The raw location string to clean and standardize. Can be a full address, city/state, or place name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Clean school data
>
> **Slug:** `PEOPLEDATALABS_CLEAN_SCHOOL_DATA`
>
> Cleans and standardizes school information; provide at least one of the school's name, website, or profile for optimal results.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0 per request
>
> #### Input Parameters
>
> **name** `string`
>
> The name of the school.
>
> **pretty** `boolean`
>
> If true, the JSON response is pretty-printed with human-readable indentations.
>
> **profile** `string`
>
> The social media profile URL (e.g., LinkedIn, Twitter) of the school.
>
> **website** `string`
>
> The website URL of the school.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Clean school data (POST)
>
> **Slug:** `PEOPLEDATALABS_CLEAN_SCHOOL_DATA_POST`
>
> Tool to clean and standardize school data using POST method. Use when you need to clean school information by providing name, website, or profile.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0 per request
>
> #### Input Parameters
>
> **name** `string`
>
> The name of the school to clean and standardize.
>
> **pretty** `boolean`
>
> Whether the output should have human-readable indentation.
>
> **profile** `string`
>
> A social profile used by the school (e.g. LinkedIn/Facebook/Twitter).
>
> **website** `string`
>
> A website the school uses.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Enrich Bulk Company Data
>
> **Slug:** `PEOPLEDATALABS_ENRICH_BULK_COMPANY_DATA`
>
> Tool to enrich up to 100 companies in a single request using the Bulk Company Enrichment API. Use when you need to enrich multiple company profiles efficiently. Each request must include at least one company identifier (website, profile, name, ticker, or pdl\_id). Results are returned in the same order as the input requests, with individual status codes indicating success (200) or failure (404).
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.1 per company matched in the batch
>
> **Discount:** 35
>
> #### Input Parameters
>
> **requests** `array` *required*
>
> Array of 1-100 individual company enrichment requests. Each request must contain a params object with at least one company identifier.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Enrich bulk person data
>
> **Slug:** `PEOPLEDATALABS_ENRICH_BULK_PERSON_DATA`
>
> Enrich up to 100 person profiles in one Bulk Person Enrichment request using supported identifiers and matching parameters. Results contain individual statuses and follow the order of the input requests.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.28 per person matched in the batch
>
> **Discount:** 10
>
> #### Input Parameters
>
> **requests** `array` *required*
>
> Array of 1-100 individual enrichment requests, each containing a 'params' object with person identifiers.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Enrich Company Data
>
> **Slug:** `PEOPLEDATALABS_ENRICH_COMPANY_DATA`
>
> Enrich company data from People Data Labs with firmographics and employee counts using a company ID, name, social profile, ticker, or website. Successful matches consume enrichment credits; a no-match response is free.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.1 per company matched
>
> **Discount:** 35
>
> #### Input Parameters
>
> **name** `string`
>
> REQUIRED if no other identifier provided. Company name to search for. At least one of pdl\_id/name/profile/ticker/website must be provided.
>
> **pdl\_id** `string`
>
> REQUIRED if no other identifier provided. People Data Labs unique ID for a company. At least one of pdl\_id/name/profile/ticker/website must be provided.
>
> **pretty** `boolean`
>
> If true, the JSON response will be pretty-printed with human-readable indentation for easier inspection.
>
> **region** `string`
>
> The state, province, or administrative region where the company is located (e.g., 'California' or 'TX').
>
> **ticker** `string`
>
> REQUIRED if no other identifier provided. Stock market ticker symbol. At least one of pdl\_id/name/profile/ticker/website must be provided.
>
> **country** `string`
>
> The country where the company is located. Can be a full name or an ISO country code.
>
> **profile** `string`
>
> REQUIRED if no other identifier provided. Company social media profile URL. At least one of pdl\_id/name/profile/ticker/website must be provided.
>
> **website** `string`
>
> REQUIRED if no other identifier provided. Company website URL. At least one of pdl\_id/name/profile/ticker/website must be provided.
>
> **locality** `string`
>
> The city or locality where the company is situated (e.g., 'Mountain View').
>
> **location** `string`
>
> A general text query for the company's location (e.g., 'San Francisco, CA' or 'London'). Can be a partial or complete location string.
>
> **titlecase** `boolean`
>
> If set to true, textual data in the API response will be converted to title case. If omitted, the API's default casing is used.
>
> **postal\_code** `string`
>
> The postal or ZIP code for the company's location.
>
> **street\_address** `string`
>
> The street address component of the company's location.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Enrich IP Data
>
> **Slug:** `PEOPLEDATALABS_ENRICH_IP_DATA`
>
> Enrich an IP address with People Data Labs company data and, where available and requested, IP location, metadata, and person data. Managed requests require a public IP and support company-only output.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.072 per IP address matched
>
> **Discount:** 33
>
> #### Input Parameters
>
> **ip** `string` *required*
>
> The IP address to enrich. Must be a valid IPv4 or IPv6 address string.
>
> **pretty** `boolean`
>
> If true, the JSON response will be formatted with human-readable indentation for easier manual inspection.
>
> **titlecase** `boolean`
>
> If true, relevant string values in the response data (e.g., names, locations) will be converted to title case.
>
> **return\_person** `boolean`
>
> If true, attempts to include person data associated with the IP address, provided a match is found.
>
> **min\_confidence** `string`
>
> Specifies the minimum confidence level required for a company match to be returned. Matches below this threshold are excluded. If unspecified, the API's default (often 'very low') is used. Accepted values: `very low`, `low`, `medium`, `high`, `very high`.
>
> **return\_ip\_location** `boolean`
>
> If true, includes location data specific to the IP address (e.g., city, region, country, GPS coordinates).
>
> **return\_ip\_metadata** `boolean`
>
> If true, includes metadata specific to the IP address (e.g., connection type, line speed, ISP).
>
> **return\_if\_unmatched** `boolean`
>
> If true, IP-specific data (like location or metadata if requested) will be returned even if no company profile is matched to the IP.
>
> **updated\_title\_roles** `boolean`
>
> If true, the API will use an updated taxonomy for job title roles in the response. Refer to People Data Labs documentation for specifics on this taxonomy.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Enrich job title data
>
> **Slug:** `PEOPLEDATALABS_ENRICH_JOB_TITLE_DATA`
>
> Enrich a job title with a cleaned title, similar titles, and relevant skills. This action is unavailable for managed People Data Labs requests.
>
> #### Input Parameters
>
> **job\_title** `string` *required*
>
> Job title to be enriched.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Enrich person data
>
> **Slug:** `PEOPLEDATALABS_ENRICH_PERSON_DATA`
>
> Enriches person data using various identifiers; requires a primary ID (profile, email, phone, email\_hash, lid, pdl\_id) OR a name (full, or first and last) combined with another demographic detail (e.g., company, school, location).
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.28 per person matched
>
> **Discount:** 10
>
> #### Input Parameters
>
> **lid** `string`
>
> LinkedIn ID.
>
> **name** `string`
>
> Full name.
>
> **email** `string`
>
> Email address.
>
> **phone** `string`
>
> Phone number; E.164 format recommended.
>
> **pdl\_id** `string`
>
> People Data Labs unique record ID.
>
> **pretty** `boolean`
>
> Format JSON response with indentation for readability.
>
> **region** `string`
>
> State, province, or region of residence.
>
> **school** `string`
>
> School name attended.
>
> **company** `string`
>
> Company name where person has worked.
>
> **country** `string`
>
> Country of residence (ISO 3166-1 alpha-2 code or full name).
>
> **profile** `string`
>
> Social profile URL (e.g., LinkedIn, Facebook).
>
> **locality** `string`
>
> City or locality of residence.
>
> **location** `string`
>
> General location (e.g., city, state, country).
>
> **required** `string`
>
> Boolean expression of top-level fields required in enriched profile for match. Use AND/OR operators and parentheses for logic (e.g., 'emails AND phone\_numbers', 'education AND (emails OR phone\_numbers)'). Valid fields: emails, phone\_numbers, experience, education, job\_title, job\_company\_name, full\_name, location\_country, work\_email, personal\_emails, mobile\_phone, linkedin\_url, profiles, skills, etc.
>
> **last\_name** `string`
>
> Last name.
>
> **birth\_date** `string`
>
> Birth date (YYYY-MM-DD format).
>
> **email\_hash** `string`
>
> SHA-256 or MD5 hash of an email, for matching without exposing the raw email.
>
> **first\_name** `string`
>
> First name.
>
> **postal\_code** `string`
>
> Postal or ZIP code of residence.
>
> **data\_include** `string`
>
> Comma-separated data fields to include in response (e.g., 'emails,phones'). Refer to People Data Labs docs for all fields.
>
> **min\_likelihood** `integer`
>
> Minimum confidence score (0-10) for a match to be returned; higher is stricter.
>
> **street\_address** `string`
>
> Street address.
>
> **include\_if\_matched** `boolean`
>
> Include input parameters used for matching in the response if true.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Enrich skill data
>
> **Slug:** `PEOPLEDATALABS_ENRICH_SKILL_DATA`
>
> Retrieves detailed, standardized information for a given skill by querying the People Data Labs Skill Enrichment API; for best results, provide a recognized professional skill or area of expertise.
>
> #### Input Parameters
>
> **skill** `string` *required*
>
> The specific skill term to be enriched. This skill will be matched against a skill dataset to retrieve detailed information.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate Search Query
>
> **Slug:** `PEOPLEDATALABS_GENERATE_SEARCH_QUERY`
>
> DEPRECATED: This action is deprecated and will be removed in a future release. Converts natural language queries into structured PDL Elasticsearch queries for people or company searches; generates optimized query structure without executing the search.
>
> #### Input Parameters
>
> **query** `string` *required*
>
> A natural language query to search for information about people or companies, interpreted to fetch relevant data from the PeopleDataLabs dataset.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Autocomplete field suggestions
>
> **Slug:** `PEOPLEDATALABS_GET_AUTOCOMPLETE_SUGGESTIONS`
>
> Provides autocompletion suggestions for a specific field (e.g., company, skill, title) based on partial text input.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0 per request
>
> #### Input Parameters
>
> **size** `integer`
>
> Maximum number of autocomplete suggestions to return.
>
> **text** `string`
>
> Initial text to autocomplete (e.g., 'goo' for 'google').
>
> **field** `string` *required*
>
> Field for which to request autocompletion suggestions. Supported values: all\_location, class, company, country, industry, location, location\_name, major, region, role, school, skill, sub\_role, title, website.
>
> **pretty** `boolean`
>
> If true, formats the JSON output for human readability.
>
> **titlecase** `boolean`
>
> If true, returns suggestions in title case.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get autocomplete suggestions (POST)
>
> **Slug:** `PEOPLEDATALABS_GET_AUTOCOMPLETE_SUGGESTIONS_POST`
>
> Tool to get autocompletion suggestions using POST method for complex query parameters. Use when building type-ahead interfaces or needing to suggest values for Search API queries. Supports company, location, skill, title, and other fields with configurable result size.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0 per request
>
> #### Input Parameters
>
> **size** `integer`
>
> Maximum number of autocomplete suggestions to return. Must be between 1 and 100.
>
> **text** `string`
>
> Initial text to autocomplete (e.g., 'goo' for 'google'). Empty string returns all available values for the field.
>
> **field** `string ("company" | "country" | "industry" | "location" | "major" | "region" | "role" | "school" | "sub_role" | "skill" | "title")` *required*
>
> Field for which to request autocompletion suggestions. Determines the type of suggestions returned.
>
> **pretty** `boolean`
>
> If true, formats the JSON output for human readability.
>
> **titlecase** `boolean`
>
> If true, returns suggestions in title case.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get column details
>
> **Slug:** `PEOPLEDATALABS_GET_COLUMN_DETAILS`
>
> Look up predefined enum values and their descriptions for a specified column. The result indicates whether the column appears in the available enum mappings.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0 per request
>
> #### Input Parameters
>
> **column** `string` *required*
>
> Name of the column to fetch enum values for; must be a key in `enum_mappings.json`.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get schema
>
> **Slug:** `PEOPLEDATALABS_GET_SCHEMA`
>
> Retrieves the schema, including field names, descriptions, and data types, for 'person' or 'company' entity types.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0 per request
>
> #### Input Parameters
>
> **entity\_type** `string` *required*
>
> The type of entity for which to retrieve the schema. Must be either 'person' or 'company'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get subject requests
>
> **Slug:** `PEOPLEDATALABS_GET_SUBJECT_REQUESTS`
>
> Retrieve a redirect URL for the authenticated account's person data subject requests, for privacy compliance review.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Identify person data
>
> **Slug:** `PEOPLEDATALABS_IDENTIFY_PERSON_DATA`
>
> Identify person profiles in People Data Labs using attributes such as email, phone, profile URL, name, company, or location. Returns a list of matching profiles with match scores when available.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.55 per Person Identify request
>
> **Discount:** 9
>
> #### Input Parameters
>
> **lid** `string`
>
> The person's LinkedIn ID. This is a numerical ID found in some LinkedIn URLs.
>
> **name** `string`
>
> The full name of the person.
>
> **email** `string`
>
> An email address associated with the person.
>
> **phone** `string`
>
> A phone number associated with the person.
>
> **pretty** `boolean`
>
> If true, the JSON response is pretty-printed for easier human readability.
>
> **region** `string`
>
> The state, province, or region where the person resides or has resided.
>
> **school** `string`
>
> The name of an educational institution the person attended.
>
> **company** `string`
>
> The name of a company where the person is or was employed.
>
> **profile** `string`
>
> A social media profile URL associated with the person, e.g., a LinkedIn or Twitter profile URL.
>
> **locality** `string`
>
> The city or locality where the person resides or has resided.
>
> **location** `string`
>
> A general location query (e.g., 'San Francisco, CA', 'London, UK') associated with the person.
>
> **last\_name** `string`
>
> The last name of the person.
>
> **titlecase** `boolean`
>
> If true, returns all text values in title case (e.g., 'John Doe'). Otherwise, text is returned as is.
>
> **email\_hash** `string`
>
> An MD5 or SHA-256 hash of the person's email address.
>
> **first\_name** `string`
>
> The first name of the person.
>
> **postal\_code** `string`
>
> The postal or ZIP code where the person resides or has resided.
>
> **street\_address** `string`
>
> The street address where the person resides or has resided.
>
> **include\_if\_matched** `boolean`
>
> If true, the response will include a 'matched\_on' attribute, an array of strings indicating which input parameters led to the match.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] People Search with Elasticsearch
>
> **Slug:** `PEOPLEDATALABS_PEOPLE_SEARCH_ELASTIC`
>
> Search People Data Labs person profiles using an Elasticsearch DSL query, with criteria such as job title, skills, company, and location. Choose a dataset and request up to 100 records per page, with a total count and a scroll token for subsequent pages.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.28 per person returned
>
> **Discount:** 10
>
> #### Input Parameters
>
> **size** `integer`
>
> The number of matched person records to return. Must be an integer between 1 and 100, inclusive.
>
> **query** `string` *required*
>
> Elasticsearch DSL query string (JSON object) for searching PDL person profiles. Provide just the DSL body (e.g., '\{"bool": \{...}}') without an outer 'query' wrapper.  Supported query types: term, terms, match, match\_phrase, prefix, wildcard, range, exists, bool (must/should/filter/must\_not).  ALL field names MUST use snake\_case, NOT camelCase.  Valid queryable fields include: - Name: full\_name, first\_name, last\_name, middle\_name - Job: job\_title, job\_title\_role, job\_title\_class, job\_company\_name, job\_company\_industry, job\_company\_size, job\_company\_website, job\_company\_location\_\* - Location (NOT 'location' alone): location\_country, location\_region, location\_locality, location\_metro, location\_geo - Social: linkedin\_url, linkedin\_username, linkedin\_id, facebook\_url, facebook\_username, twitter\_url, twitter\_username, github\_url, github\_username - Nested profiles: profiles.network, profiles.url, profiles.username, profiles.id - Other: industry, skills, interests, countries, sex, work\_email, personal\_emails  NOT queryable as fields (use 'dataset' parameter instead): email, phone. 'experience\_level' is not valid — use 'job\_title\_levels'. 'job\_company\_domain' is not valid — use 'job\_company\_website'. 'minimum\_should\_match' is not supported by PDL's API.  Full field reference: [https://docs.peopledatalabs.com/docs/fields-person](https://docs.peopledatalabs.com/docs/fields-person)
>
> **pretty** `boolean`
>
> If true, formats the JSON response with human-readable indentation. Defaults to false.
>
> **dataset** `string`
>
> Specifies the dataset category to search against, filtering results to profiles that have the specified type of data available. Allowed values are: 'resume', 'email', 'phone', 'mobile\_phone', 'street\_address', 'consumer\_social', 'developer', 'all'. Note: Use 'email' here to filter for profiles with email addresses available, rather than querying 'email' as a field in the query parameter.
>
> **titlecase** `boolean`
>
> If true, titlecases the person records in the response. Defaults to false.
>
> **scroll\_token** `string`
>
> A token returned in a previous search response. Provide this token to retrieve the next page of results. Omit or pass an empty string for the first request.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Query person changelog
>
> **Slug:** `PEOPLEDATALABS_QUERY_PERSON_CHANGELOG`
>
> Query the person changelog between dataset versions for updates, additions, deletions, merges, and opt-outs. Managed access requires 1–100 person IDs and consecutive same-major versions; its results are limited to those IDs and omit continuation tokens.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0 per request
>
> #### Input Parameters
>
> **ids** `array`
>
> List of person IDs to query. With your own PDL key, 1 to 60000 IDs are accepted and type may be used instead. Otherwise 1 to 100 IDs are required, continuation tokens are not supported, and only the requested IDs are returned.
>
> **type** `string ("added" | "deleted" | "updated" | "merged" | "opted_out")`
>
> Type of changelog entry.
>
> **scroll\_token** `string`
>
> Token for pagination through large result sets. Use the scroll\_token returned from a previous request to get the next page of results.
>
> **fields\_updated** `array`
>
> Specifies which fields were updated between versions. Only allowed when type is 'updated'. Use to filter for specific field changes (e.g., \['email', 'phone\_numbers', 'job\_title']).
>
> **origin\_version** `string` *required*
>
> The older dataset version in 'major.minor' format. Without your own PDL key, only consecutive versions within one major only, such as 35.1 to 35.2. Dataset versions change over time; use the version returned by enrichment and the immediately preceding release.
>
> **current\_version** `string` *required*
>
> The newer dataset version in 'major.minor' format. Without your own PDL key, it must be the next minor release in the same major as origin\_version, such as 35.1 to 35.2.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve person
>
> **Slug:** `PEOPLEDATALABS_RETRIEVE_PERSON`
>
> Retrieve one person deterministically by persistent People Data Labs ID.
>
> #### Input Parameters
>
> **pretty** `boolean`
>
> Whether the provider should pretty-print its JSON response.
>
> **person\_id** `string` *required*
>
> Persistent People Data Labs person ID to retrieve.
>
> **titlecase** `boolean`
>
> Whether to title-case text in the returned person record.
>
> **filter\_updated** `string`
>
> Return the person only when one of these fields was updated; multiple values are comma-separated on the wire.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Company Search with Elasticsearch
>
> **Slug:** `PEOPLEDATALABS_SEARCH_COMPANY_ELASTIC`
>
> Performs a search for company profiles within People Data Labs using a custom Elasticsearch Domain Specific Language (DSL) query. This action allows for detailed and complex filtering based on various attributes of a company, such as name, industry, employee\_count, founded year, location, and more. Results can be paginated using the `size` and `scroll_token` parameters. Preconditions: - The `query` parameter must contain a valid Elasticsearch DSL query string, structured as a JSON object. - This action queries the People Data Labs company search endpoint (`/v5/company/search`) and returns company records.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.1 per company returned
>
> **Discount:** 35
>
> #### Input Parameters
>
> **size** `integer`
>
> The number of matched company records to return. Must be an integer between 1 and 100, inclusive.
>
> **query** `string` *required*
>
> Elasticsearch DSL query string (JSON object) for searching People Data Labs company profiles.  **Supported query types:** term, terms, match, match\_phrase, range, exists, bool (must/should/filter/must\_not), wildcard, prefix.  **Common Company Fields:** name, display\_name, website, industry, employee\_count, founded, size, location.country, location.region, location.locality, location.name, tags, linkedin\_url, type, summary.  **Location Searches:** Use nested fields: `location.country`, `location.region`, `location.locality`, `location.name`. Example: `{"term": {"location.country": "united states"}}`.  **Important Restrictions:** - Do NOT include `size` or `scroll_token` in this query; use the dedicated request fields. - Do NOT use `minimum_should_match` in bool queries.  For complete field mappings, see [https://docs.peopledatalabs.com/docs/company-search-api](https://docs.peopledatalabs.com/docs/company-search-api).
>
> **pretty** `boolean`
>
> If true, the JSON response will be pretty-printed with human-readable indentation. Defaults to false.
>
> **titlecase** `boolean`
>
> If true, an attempt will be made to title-case relevant text fields in the returned company records. Defaults to false.
>
> **scroll\_token** `string`
>
> A token returned from a previous search response, used for paginating through large result sets. Provide this token to retrieve the next batch of `size` records. Leave empty or omit for the first request.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Company Records (POST)
>
> **Slug:** `PEOPLEDATALABS_SEARCH_COMPANY_POST`
>
> Tool to search and filter company records from the full Company Dataset using Elasticsearch or SQL queries via POST method. Use when you need to find multiple companies matching specific criteria with complex filtering.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.1 per company returned
>
> **Discount:** 35
>
> #### Input Parameters
>
> **sql** `string`
>
> SQL query format: SELECT \* FROM company WHERE \[condition]. Either 'query' or 'sql' is required, but not both.
>
> **size** `integer`
>
> Batch size/max records returned. Must be between 1 and 100. Default: 1
>
> **query** `string`
>
> An Elasticsearch (v7.7) DSL query for searching company data. Must be a valid JSON object as a string. Either 'query' or 'sql' is required, but not both.
>
> **pretty** `boolean`
>
> Human-readable JSON formatting. Default: false
>
> **titlecase** `boolean`
>
> Titlecase response text. Default: false
>
> **from\_offset** `integer`
>
> Legacy offset for pagination (0-9999), max 10000 records total. Use scroll\_token for unlimited pagination.
>
> **scroll\_token** `string`
>
> Pagination token from previous response for unlimited record retrieval. Use this for paginating beyond 10000 records.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search job postings
>
> **Slug:** `PEOPLEDATALABS_SEARCH_JOB_POSTINGS`
>
> Search PDL's Job Posting Dataset using one filter mode and cursor pagination. Charged per job returned; failed requests are free.
>
> #### Input Parameters
>
> **id** `string`
>
> Exact PDL job posting ID.
>
> **size** `integer`
>
> Maximum records to return, from 1 to 100. Charged per record returned.
>
> **query** `object`
>
> Elasticsearch 7.7 query. Cannot be combined with field filters.
>
> **title** `string`
>
> Cleaned, case-insensitive job title phrase.
>
> **pretty** `boolean`
>
> Whether the provider should indent its JSON response.
>
> **location** `string`
>
> Cleaned city, region, or country location.
>
> **is\_active** `boolean`
>
> Whether to return active or deactivated postings.
>
> **company\_id** `string`
>
> Exact PDL company ID.
>
> **title\_role** `string`
>
> Canonical job title role.
>
> **description** `string`
>
> Case-insensitive job description phrase.
>
> **title\_class** `string`
>
> Canonical job title class.
>
> **company\_name** `string`
>
> Cleaned company name.
>
> **scroll\_token** `string`
>
> Opaque token from the previous page. Send it unchanged.
>
> **title\_levels** `string`
>
> Canonical job seniority level.
>
> **salary\_period** `string ("annual" | "monthly" | "weekly" | "biweekly" | "daily" | "hourly" | "minute")`
>
> Canonical salary payment period.
>
> **first\_seen\_max** `string`
>
> Inclusive latest first-seen date in YYYY-MM-DD format.
>
> **first\_seen\_min** `string`
>
> Inclusive earliest first-seen date in YYYY-MM-DD format.
>
> **title\_sub\_role** `string`
>
> Canonical job title sub-role.
>
> **company\_profile** `string`
>
> Cleaned company LinkedIn profile URL.
>
> **company\_website** `string`
>
> Cleaned company website.
>
> **inferred\_skills** `string`
>
> Skill text to match against inferred skills.
>
> **salary\_currency** `string`
>
> Canonical lowercase salary currency code.
>
> **company\_industry** `string`
>
> Company industry phrase.
>
> **salary\_range\_max** `integer`
>
> Inclusive maximum salary amount.
>
> **salary\_range\_min** `integer`
>
> Inclusive minimum salary amount.
>
> **last\_verified\_max** `string`
>
> Inclusive latest verification date in YYYY-MM-DD format.
>
> **last\_verified\_min** `string`
>
> Inclusive earliest verification date in YYYY-MM-DD format.
>
> **remote\_work\_policy** `string ("hybrid" | "onsite" | "remote")`
>
> Canonical remote work policy.
>
> **company\_industry\_v2** `string`
>
> Company V2 industry phrase.
>
> **deactivated\_date\_max** `string`
>
> Inclusive latest deactivation date in YYYY-MM-DD format.
>
> **deactivated\_date\_min** `string`
>
> Inclusive earliest deactivation date in YYYY-MM-DD format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
