People Data Labs

Maximum number of autocomplete suggestions to return.

Initial text to autocomplete (e.g., 'goo' for 'google').

Field for which to request autocompletion suggestions. Supported values: company, country, industry, location, major, region, role, school, skill, sub_role, title, website.

If true, formats the JSON output for human readability.

If true, returns suggestions in title case.

Array of suggestion objects, each detailing an autocomplete suggestion.

Error if any occurred during the execution of the action

List of fields for which suggestions were actually provided.

Whether or not the action execution was successful or not

The company's current or known name.

If true, formats the JSON response with human-readable indentation.

The company's social media profile URL.

The company's website URL.

Cleaned and standardized company data. Its structure and fields can vary based on the input and the information cleaned.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

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.

A dictionary containing the cleaned, standardized, and potentially enriched location data returned by the API. The structure and fields within this dictionary can vary based on the input and the information derived (e.g., city, state, country, postal_code, geo-coordinates).

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The name of the school.

If true, the JSON response is pretty-printed with human-readable indentations.

The social media profile URL (e.g., LinkedIn, Twitter) of the school.

The website URL of the school.

A dictionary containing the cleaned, standardized, and potentially enriched school information returned by the API.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The number of matched person records to return. Must be an integer between 1 and 100, inclusive.

Elasticsearch DSL query string used to search for person profiles from People Data Labs. This field requires a well-formed JSON object as a string, representing the Elasticsearch query. **Key Guidelines for Query Construction:** 1. **Valid Fields:** Queries must use fields corresponding to the PDL person profile schema (e.g., `job_title`, `location_country`, `skills`, `inferred_years_experience`). 2. **Query Types:** Employ appropriate Elasticsearch query types based on the field type and desired logic: * `term`: For exact matches on keyword fields (e.g., specific IDs, canonicalized location names, tags). * `terms`: For matching any of multiple exact terms in keyword fields. * `match`: For full-text searches on analyzed text fields (e.g., free-form text in summaries, job descriptions). * `match_phrase`: For exact phrase matching within text fields. * `range`: For filtering by numeric or date ranges (e.g., `inferred_years_experience: {"gte": 5}`). * `exists`: To find documents where a specific field has a value (is not null). * `bool`: To combine multiple query clauses using: * `must`: Clauses that *must* match (AND logic). * `should`: Clauses where at least one *should* match (OR logic). * `filter`: Clauses that *must* match, but are executed in a non-scoring context (often for performance). * `must_not`: Clauses that *must not* match (NOT logic). * `wildcard`: For pattern matching using `*` (multiple characters) or `?` (single character). Especially useful for location fields (e.g., `location_name: "*francisco*"`). * `prefix`: For matching terms that start with a given prefix. 3. **Contextual Queries:** Use `query` context (e.g., within `must` or `should` of a `bool` query) for conditions that should affect the relevance score. Use `filter` context for exact criteria that do not need to influence scoring, which can be more performant. 4. **Best Practices & Important Notes:** * **Field Specifics:** This action searches *person* data. Ensure query fields are relevant to person attributes. * **Canonical Values:** For fields with predefined (canonical) values, use exact matches with `term` or `terms` queries. * **Location Searches:** `wildcard` queries are often effective for location fields like `location_country`, `location_region`, `location_name`. For example: `{"wildcard": {"location_country": "*united states*"}}`. * **Boolean Logic:** When using `bool` queries, ensure that conditions in `must` or `filter` clauses are not logically mutually exclusive, as this would yield no results. * **Exclusions:** Do NOT include `size` or `scroll_token` parameters within this DSL query string; use the dedicated request fields for these pagination parameters. * **`minimum_should_match`:** Do NOT use the `minimum_should_match` parameter in `bool` queries. * **Non-Canonical Inputs:** If dealing with user input that may not be canonical (e.g., free-text location), attempt to map it to a known canonical value for a `term` query, or use broader `match` or `wildcard` queries. This summary provides key guidelines. For comprehensive DSL syntax, advanced features, specific field mappings for PDL person data, and detailed behavior of query types, always consult the official Elasticsearch documentation and People Data Labs API documentation.

If true, the JSON response will be pretty-printed with human-readable indentation. Defaults to false.

Specifies the dataset category to search against. Accepted values are: 'resume', 'email', 'phone', 'mobile_phone', 'street_address', 'consumer_social', 'developer', or 'all'.

If true, an attempt will be made to title-case relevant text fields in the returned person records. Defaults to false.

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.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The company's official or commonly known name.

The People Data Labs (PDL) unique identifier for a company record. Use this for the most precise match if available.

If true, the JSON response will be pretty-printed with human-readable indentation for easier inspection.

The state, province, or administrative region where the company is located (e.g., 'California' or 'TX').

The company's stock market ticker symbol.

The country where the company is located. Can be a full name or an ISO country code.

A URL for one of the company's social media profiles (e.g., LinkedIn, Crunchbase).

The company's primary website URL.

The city or locality where the company is situated (e.g., 'Mountain View').

A general text query for the company's location (e.g., 'San Francisco, CA' or 'London'). Can be a partial or complete location string.

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.

The postal or ZIP code for the company's location.

The street address component of the company's location.

Contains the enriched company information returned by the API.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The IP address to enrich. Must be a valid IPv4 or IPv6 address string.

If true, the JSON response will be formatted with human-readable indentation for easier manual inspection.

If true, relevant string values in the response data (e.g., names, locations) will be converted to title case.

If true, attempts to include person data associated with the IP address, provided a match is found.

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`.

If true, includes location data specific to the IP address (e.g., city, region, country, GPS coordinates).

If true, includes metadata specific to the IP address (e.g., connection type, line speed, ISP).

If true, IP-specific data (like location or metadata if requested) will be returned even if no company profile is matched to the IP.

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.

A dictionary containing the enriched data for the specified IP address. The exact structure and content of this dictionary depend on the input parameters and the information found by the API.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Job title to be enriched.

Enriched information for the provided job title.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

LinkedIn ID.

Full name.

Email address.

Phone number; E.164 format recommended.

People Data Labs unique record ID.

Format JSON response with indentation for readability.

State, province, or region of residence.

School name attended.

Company name where person has worked.

Country of residence (ISO 3166-1 alpha-2 code or full name).

Social profile URL (e.g., LinkedIn, Facebook).

City or locality of residence.

General location (e.g., city, state, country).

Comma-separated fields required in enriched profile for a match (e.g., 'emails.address,phones.number'). See PDL docs for field paths.

Last name.

Birth date (YYYY-MM-DD format).

SHA-256 or MD5 hash of an email, for matching without exposing the raw email.

First name.

Postal or ZIP code of residence.

Comma-separated data fields to include in response (e.g., 'emails,phones'). Refer to People Data Labs docs for all fields.

Minimum confidence score (0-10) for a match to be returned; higher is stricter.

Street address.

Include input parameters used for matching in the response if true.

Dictionary with enriched person profile; structure and fields vary by input and availability.

Error if any occurred during the execution of the action

Confidence score (0-10) of the match; present if a match found. Higher score means more confident.

Whether or not the action execution was successful or not

The specific skill term to be enriched. This skill will be matched against a skill dataset to retrieve detailed information.

A dictionary containing the enriched information for the specified skill. This typically includes details retrieved from a skill dataset after matching the input skill.

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

A natural language query to search for information about people or companies, interpreted to fetch relevant data from the PeopleDataLabs dataset.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Name of the column to fetch enum values for; must be a key in `enum_mappings.json`.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The type of entity for which to retrieve the schema. Must be either 'person' or 'company'.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The person's LinkedIn ID. This is a numerical ID found in some LinkedIn URLs.

The full name of the person.

An email address associated with the person.

A phone number associated with the person.

If true, the JSON response is pretty-printed for easier human readability.

The state, province, or region where the person resides or has resided.

The name of an educational institution the person attended.

The name of a company where the person is or was employed.

A social media profile URL associated with the person, e.g., a LinkedIn or Twitter profile URL.

The city or locality where the person resides or has resided.

A general location query (e.g., 'San Francisco, CA', 'London, UK') associated with the person.

The last name of the person.

If true, returns all text values in title case (e.g., 'John Doe'). Otherwise, text is returned as is.

An MD5 or SHA-256 hash of the person's email address.

The first name of the person.

The postal or ZIP code where the person resides or has resided.

The street address where the person resides or has resided.

If true, the response will include a 'matched_on' attribute, an array of strings indicating which input parameters led to the match.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

The number of matched person records to return. Must be an integer between 1 and 100, inclusive.

An Elasticsearch Domain Specific Language (DSL) query string, formatted as a JSON object, for searching People Data Labs (PDL) person profiles. This allows for complex searches using boolean logic, term matching, wildcards, and filters on attributes like job title, industry, and location. The query must use fields defined in the PDL schema. For detailed syntax and field names, consult Elasticsearch and PDL documentation. Incorrect queries may lead to errors.

If true, formats the JSON response with human-readable indentation. Defaults to false.

Specifies the dataset category to search against. Allowed values are 'resume', 'email', 'phone', 'mobile_phone', 'street_address', 'consumer_social', 'developer', 'all'.

If true, titlecases the person records in the response. Defaults to false.

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.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not