Output Response - Autocomplete API

Detailed information on the output response that the Autocomplete API returns

Response Data Structure

Abridged Response Data Structure

Here is an example response from the Autocomplete API when querying for field = "company" and text = "goog":

{
  "data": [
     {
      "name": "google",
      "count": 363379,
      "meta": {
        "id": "google",
        "website": "google.com",
        "industry": "internet",
        "location_name": "mountain view, california, united states",
        "display_name": "Google",
        "display_name_history": [
          "Google"
        ],
        "alternative_names": [
          "谷歌",
          "google, social marketing tools",
          "구글",
          "google inc.",
          "google pay",
          "google, inc.",
          "google deepmind",
          "google inc",
          "google digital skills for africa",
          "google, inc"
        ]
      }
    },
   ...
  ],
  "fields": [
    "job_company_name",
    "experience.company.name"
  ],
  "status": 200
}

Full Example Response

Full Output Response (click to expand)
{
    "data": [
        {
            "name": "google",
            "count": 363379,
            "meta": {
                "id": "google",
                "website": "google.com",
                "industry": "internet",
                "location_name": "mountain view, california, united states",
                "display_name": "Google",
                "display_name_history": [
                    "Google"
                ],
                "alternative_names": [
                    "谷歌",
                    "google, social marketing tools",
                    "구글",
                    "google inc.",
                    "google pay",
                    "google, inc.",
                    "google deepmind",
                    "google inc",
                    "google digital skills for africa",
                    "google, inc"
                ]
            }
        },
        {
            "name": "google operations center",
            "count": 4642,
            "meta": {
                "id": "googleoperationscenter",
                "website": "googleoperationscenter.com",
                "industry": "internet",
                "location_name": null,
                "display_name": "Google Operations Center",
                "display_name_history": [
                    "Google Operations Center"
                ],
                "alternative_names": [
                    "google",
                    "google data center",
                    "google operations center.",
                    "google operations center philippines",
                    "associated engineering surveyors limited",
                    "google operations",
                    "google operation center",
                    "google express",
                    "google/google operations center",
                    "metas of seventh day adventists school"
                ]
            }
        },
        {
            "name": "bangkit academy led by google, tokopedia, gojek, & traveloka",
            "count": 2710,
            "meta": {
                "id": "bangkit-academy",
                "website": "bangkit.academy",
                "industry": "information technology and services",
                "location_name": "jakarta, indonesia",
                "display_name": "Bangkit Academy led by Google, Tokopedia, Gojek, & Traveloka",
                "display_name_history": [
                    "Bangkit Academy led by Google, Tokopedia, Gojek, & Traveloka"
                ],
                "alternative_names": [
                    "google bangkit",
                    "bangkit academy led by google, tokopedia, gojek & traveloka",
                    "bangkit",
                    "bangkit led by google, tokopedia, gojek & traveloka",
                    "bangkit academy led by google, tokopedia, gojek, & traveloka participant",
                    "bangkit academy l",
                    "bangkit academy led by google, goto, & traveloka",
                    "bangkit academy led google, tokopedia, gojek & traveloka",
                    "bangkit academy",
                    "bangk"
                ]
            }
        },
        {
            "name": "google adsense",
            "count": 2235,
            "meta": {
                "id": "google-adsense",
                "website": "google.com/adsense",
                "industry": "consumer services",
                "location_name": "mountain view, california, united states",
                "display_name": "Google AdSense",
                "display_name_history": [
                    "Google AdSense"
                ],
                "alternative_names": [
                    "google",
                    "wahana kerja indonesia",
                    "google ph.g, htc champions, lg ambassadors",
                    "thecspedia.com",
                    "gtplast ab",
                    "blogger",
                    "google adsense, facebook ads, google adwords, affiliate marketing",
                    "google adsense and amazon product ranking",
                    "self-employed",
                    "google llc"
                ]
            }
        },
        {
            "name": "google deepmind",
            "count": 1862,
            "meta": {
                "id": "googledeepmind",
                "website": "deepmind.com",
                "industry": "research",
                "location_name": "london, london, united kingdom",
                "display_name": "Google DeepMind",
                "display_name_history": [
                    "Google DeepMind",
                    "DeepMind"
                ],
                "alternative_names": [
                    "deepmind",
                    "deepmind health",
                    "deepmind / google health",
                    "building something new",
                    "self-employed",
                    "deepmind technlogies",
                    "deepmind (google)",
                    "deepmind technologies",
                    "google, google health",
                    "deepmind technologies limited"
                ]
            }
        },
        {
            "name": "google developers",
            "count": 1833,
            "meta": {
                "id": "googledevelopers",
                "website": "developers.google.com",
                "industry": "internet",
                "location_name": "mountain view, california, united states",
                "display_name": "Google Developers",
                "display_name_history": [
                    "Google Developers"
                ],
                "alternative_names": [
                    "google",
                    "google developers students club utp",
                    "google developers experts program",
                    "google developer student clubs ntou",
                    "developer student clubs - muet jamshoro",
                    "developers student club al-azhar - powered by google developers",
                    "google developer student club",
                    "google africa",
                    "taiwan cogeneration corporation",
                    "google women techmakers"
                ]
            }
        },
        {
            "name": "gv (google ventures)",
            "count": 1414,
            "meta": {
                "id": "googleventures",
                "website": "gv.com",
                "industry": "venture capital & private equity",
                "location_name": "mountain view, california, united states",
                "display_name": "GV (Google Ventures)",
                "display_name_history": [
                    "GV",
                    "GV (Google Ventures)"
                ],
                "alternative_names": [
                    "gv",
                    "gv / google ventures",
                    "gv (fka google ventures)",
                    "gv servcios",
                    "gv (formerly known as google ventures)",
                    "gvg",
                    "gv gerenciamento de risco",
                    "google ventures"
                ]
            }
        },
        {
            "name": "google developer student clubs",
            "count": 1346,
            "meta": {
                "id": "dscjscoe",
                "website": "developers.google.com/community/gdsc",
                "industry": "education management",
                "location_name": "pune, maharashtra, india",
                "display_name": "Google Developer Student Clubs",
                "display_name_history": [
                    "DSC JSCOE, Pune",
                    "Google Developer Student Clubs"
                ],
                "alternative_names": [
                    "dsc jscoe, pune",
                    "google developer student clubs iipe visakhapatnam",
                    "google developer student club",
                    "google developer student clubs- srcasw",
                    "google developer student club - bu",
                    "google developer student clubs at pnu",
                    "google developer student clubs universitas muhammadiyah malang",
                    "google developer student clubs - federal university dutsin-ma.",
                    "google developer student clubs @ queen's university",
                    "google developer student clubs oau"
                ]
            }
        },
        {
            "name": "google ads",
            "count": 1052,
            "meta": {
                "id": "goog-ads",
                "website": "g.com",
                "industry": "internet",
                "location_name": "mountain view, california, united states",
                "display_name": "Google Ads",
                "display_name_history": [
                    "Google Ads"
                ],
                "alternative_names": [
                    "nextive education ltd",
                    "freelance",
                    "google global smartphone",
                    "grupo resolv",
                    "marketing and advertising",
                    "google",
                    "ppc search marketing",
                    "majorel polska",
                    "google ads - campagne marketing per i miei clienti.",
                    "google ads - teleperformance spain"
                ]
            }
        },
        {
            "name": "google fiber",
            "count": 773,
            "meta": {
                "id": "googlefiber",
                "website": "g.co/fiber/careers",
                "industry": "internet",
                "location_name": "mountain view, california, united states",
                "display_name": "Google Fiber",
                "display_name_history": [
                    "Webpass Inc.",
                    "Google Fiber Webpass",
                    "Google Fiber"
                ],
                "alternative_names": [
                    "webpass inc.",
                    "google fiber webpass",
                    "webpass from google fiber",
                    "akorbi - google fiber",
                    "google",
                    "google fiber via iconma",
                    "webpass - a google fiber company",
                    "webpass / google fiber",
                    "webpass",
                    "google fiber (university sponsored business competition)"
                ]
            }
        }
    ],
    "fields": [
        "job_company_name",
        "experience.company.name"
    ],
    "status": 200
}

Full Beta Response

🚧

Warning: Beta Feature

The following is currently in beta and the information in this section as well as API functionality are subject to change.

Please report any issues or feedback to [email protected] and/or to your Data Consultant.

Query

{
  "field": "company",
  "text": "kraft",
  "beta": true,
  "titlecase": true,
  "size": 2
}
Full Output Response (click to expand)
{
  "data": [
    {
      "name": "The Kraft Heinz Company",
      "count": 26614,
      "meta": {
        "id": "the-kraft-heinz-company",
        "industry": "Food & Beverages",
        "location_name": "Chicago, Illinois, United States",
        "website": "kraftheinzcompany.com",
        "display_name": "The Kraft Heinz Company",
        "alternative_names": [
          "hj heinz",
          "kraft foods group",
          "h.j. heinz company",
          "亨氏",
          "heinz",
          "h.j. heinz",
          "kraft heinz company",
          "kraft foods",
          "亨氏食品公司",
          "kraft heinz"
        ],
        "display_name_history": [
          "The Kraft Heinz Company"
        ],
      }
    },
    {
      "name": "Kraft Foods Group",
      "count": 3384,
      "meta": {
        "id": "kraft-foods-group",
        "industry": "Hospitality",
        "location_name": "Carthage, Illinois, United States",
        "website": "kraftfoodsgroup.com",
        "display_name": "Kraft Foods Group",
        "alternative_names": [
          "kraft",
          "kraft heinz company",
          "the kraft heinz company",
          "kraft foods",
          "kraft foods canada",
          "kraft heinz",
          "kraft canada",
          "kraftheinz company",
          "genpact - kraft foods group",
          "kraft foods international"
        ],
        "display_name_history": [],
      }
    }
  ],
  "fields": [
    "job_company_name",
    "experience.company.name"
  ],
  "status": 200
}

Response Fields

fields

TypeDescription
Array (String)The list of fields in the Person Schema that the Autocomplete API has returned suggestions for. It determines these based on the value that you used for the field input parameter.

See the field input parameter description for the mapping between Autocomplete API fields and Person Schema fields.


data

TypeDescription
Array (Object)The list of suggestions that the Autocomplete API has returned.

It sorts results in descending order based on data.count. The size input parameter determines the size of the list.

data.count

TypeDescription
IntegerThe number of records in our Person Dataset (resume slice) for this Autocomplete suggestion.

data.name

TypeDescription
StringThe plain text Autocomplete API suggestion. For example, company name, school name, location name, title and so forth. The prefix of this field will match the value of the text input parameter.

data.meta.*

TypeDescription
ObjectA set of additional fields that the API returns for each result in the data array. The metadata fields depend on the field input parameter.

The Autocomplete API returns some additional metadata fields along with autocomplete suggestion to provide additional context about it. The specific metadata fields that it returns depends on which field was set in the input parameters.

The tables below describe the metadata fields that the API returns for each input field parameter.

Metadata Fields for Company

The metadata fields that the API returns when field = "company" in the input parameters:

Metadata FieldTypeDescriptionExample
idStringThe PDL ID for this company.peopledatalabs
websiteStringThe website associated with this company.peopledatalabs.com
industryEnum (String)The most relevant industry for this company.internet
location_nameStringThe name of the most relevant location for this company.san francisco, california, united states
display_nameStringThe company name, capitalized using the company’s self-reported name.People Data Labs
display_name_historyArray [String]A list of the company’s historical primary names with proper capitalization.["People Data Labs"]
alternative_namesArray [String]A list of other names associated with this company.[]

Metadata Fields for Country

The metadata fields that the API returns when field = "country" in the input parameters:

Metadata FieldTypeDescriptionExample
None------

Metadata Fields for Industry

The metadata fields that the API returns when field = "industry" in the input parameters:

Metadata FieldTypeDescriptionExample
None------

Metadata Fields for Location

The metadata fields that the API returns when field = "location" in the input parameters:

Metadata FieldTypeDescriptionExample
countryEnum (String)The country of this location.united states
localityStringThe locality of this location.san francisco
regionStringThe region of this location.california

Metadata Fields for Major

The metadata fields that the API returns when field = "major" in the input parameters:

Metadata FieldTypeDescriptionExample
None------

Metadata Fields for Region

The metadata fields that the API returns when field = "region" in the input parameters:

Metadata FieldTypeDescriptionExample
None------

Metadata Fields for Role

The metadata fields that the API returns when field = "role" in the input parameters:

Metadata FieldTypeDescriptionExample
None------

Metadata Fields for Sub_Role

The metadata fields that the API returns when field = "sub_role" in the input parameters:

Metadata FieldTypeDescriptionExample
roleEnum (String)The role associated with this subrole (see Mapping Title Subroles to Roles.)engineering

Metadata Fields for School

The metadata fields that the API returns when field = "school" in the input parameters:

Metadata FieldTypeDescriptionExample
location_nameStringThe name of the most relevant location for this school.eugene, oregon, united states
websiteStringThe website associated with this school.business.uoregon.edu
idStringThe PDL ID for this school.a56df063-4562-4e59-bc4c-68b33c14df1e

Metadata Fields for Skill

The metadata fields that the API returns when field = "skill" in the input parameters:

Metadata FieldTypeDescriptionExample
None------

Metadata Fields for Title

The metadata fields that the API returns when field = "title" in the input parameters:

Metadata FieldTypeDescriptionExample
None------

Metadata Fields for Website

🚧

Warning: Beta Feature

The following is currently in beta and the information in this section as well as API functionality are subject to change.

Please report any issues or feedback to [email protected] and/or to your Data Consultant.

When the beta flag is set to true, you can use the Autocomplete API with websites.

The metadata fields that the API returns when field = "website" and beta = true in the input parameters:

Metadata FieldTypeDescriptionExample
idStringThe PDL ID for this company.peopledatalabs
websiteStringThe website associated with this company.peopledatalabs.com
industryEnum (String)The most relevant industry for this company.internet
location_nameStringThe name of the most relevant location for this company.san francisco, california, united states
display_nameStringThe company name, capitalized using the company’s self-reported name.People Data Labs
display_name_historyArray [String]A list of the company’s historical primary names with proper capitalization.["People Data Labs"]
alternative_namesArray [String]A list of other names associated with this company.[]

status

TypeDescription
IntegerThe API response code.