Input Parameters - Autocomplete API

Required Parameters

`api_key`

Type	Description	Default	Example
`String`	Your secret API key.

Your API Key must be included in either the request header or the api_key parameter. For more information about request authentication, see the Authentication page.

`field`

Type	Description
`Enum (String)`	The field that the API will generate autocomplete suggestions for.

Autocomplete suggestions will be generated based on the corresponding field(s) in the Person Schema.

For example, setting field=industry will generate autocomplete suggestions for the industry, job_company_industry, and experience.company.industry person fields.

See the table below for the supported Autocomplete field values and their corresponding Person fields:

Autocomplete `field` Value	Corresponding Person Fields
`class`	• `job_title_class` • `experience.title.class`
`company`	• `job_company_name` • `experience.company.name`
`country`	• `location_country` • `countries` • `street_addresses.country` • `job_company_location_country` • `experience.company.location.country`
`industry`	• `industry` • `job_company_industry` • `experience.company.industry`
`location`	• `location_name` • `location_names` • `street_addresses.name` • `job_company_location_name` • `experience.location_names` • `experience.company.location.name`
`major`	• `education.majors` • `education.minors`
`region`	• `location_region` • `regions` • `street_addresses.region` • `job_company_location_region` • `experience.company.location.region`
`role`	• `job_title_role` • `experience.title.role`
`school`	• `education.school.name`
`sub_role`	• `job_title_sub_role` • `experience.title.sub_role`
`skill`	• `skills`
`title`	• `job_title` • `experience.title.name`
`website`	• `job_company_website` • `experience.company.website`

Optional Parameters

`text`

Type	Description	Default
`String`	The starting text to use for autocompletion.	`""`

Example

Let's see how the Autocomplete API behaves when we progressively build out tesla in the text field. Each call below represents a separate Autocomplete API call, where we keep updating the text field while keeping all other input parameters the same. For each call, we show the input parameters and the top returned result.

📘
Note: Click the Triangles To Expand Each of the API Calls Below
Each call demonstrates the input parameters and the top result that the Autocomplete API returns.

API Call 1:

text = ""

Input Parameters:

params = {
    "field": "company",
    "text": "",
    "pretty": true,
    "api_key": API_KEY,
}

Top Autocomplete Result:

"data": [
    {
      "count": 501510,
      "name": "ibm",
      "meta": {
        "website": "ibm.com",
        "industry": "information technology and services",
        "location": "new york, new york, united states"
      }
    },

API Call 2:

text = "t"

Input Parameters:

params = {
    "field": "company",
    "text": "t",
    "pretty": true,
    "api_key": API_KEY,
}

Top Autocomplete Result:

  "data": [
    {
      "count": 361642,
      "name": "tata consultancy services",
      "meta": {
        "website": "tcs.com",
        "industry": "information technology and services",
        "location": "bombay, maharashtra, india"
      }
    },

API Call 3:

text = "te"

Input Parameters:

params = {
    "field": "company",
    "text": "te",
    "pretty": true,
    "api_key": API_KEY,
}

Top Autocomplete Result:

  "data": [
    {
      "count": 102762,
      "name": "tech mahindra",
      "meta": {
        "website": "techmahindra.com",
        "industry": "information technology and services",
        "location": "pune, maharashtra, india"
      }
    },

API Call 4:

text = "tes"

Input Parameters:

params = {
    "field": "company",
    "text": "tes",
    "pretty": true,
    "api_key": API_KEY,
}

Top Autocomplete Result:

  "data": [
    {
      "count": 49735,
      "name": "tesco",
      "meta": {
        "website": "tescoplc.com",
        "industry": "retail",
        "location": "welwyn garden city, hertfordshire, united kingdom"
      }
    },

API Call 5:

text = "tesl"

Input Parameters:

params = {
    "field": "company",
    "text": "tesl",
    "pretty": true,
    "api_key": API_KEY,
}

Top Autocomplete Result:

  "data": [
    {
      "count": 39992,
      "name": "tesla",
      "meta": {
        "website": "tesla.com",
        "industry": "automotive",
        "location": "palo alto, california, united states"
      }
    },

API Call 6:

text = "tesla"

Input Parameters:

params = {
    "field": "company",
    "text": "tesla",
    "pretty": true,
    "api_key": API_KEY,
}

Top Autocomplete Result:

  "data": [
    {
      "count": 39992,
      "name": "tesla",
      "meta": {
        "website": "tesla.com",
        "industry": "automotive",
        "location": "palo alto, california, united states"
      }
    },

`size`

Type	Description	Default	Example
`Integer`	The number of results that the API should return. Must be between `1` and `100`.	`10`	`25`

`titlecase`

Type	Description	Default	Example
`Boolean`	All text in API responses returns as lowercase by default. Setting `titlecase` to `true` will titlecase any records returned instead.	`false`	`true`

`pretty`

Type	Description	Default	Example
`Boolean`	Whether the output should have human-readable indentation.	`false`	`true`

`updated_title_roles`

Type	Description	Default	Example
`Boolean`	Temporary parameter. Set to true to return the updated values for role and subrole along with the new class field.	`false`	`true`

Required Parameters

api_key

field

Optional Parameters

text

📘Note: Click the Triangles To Expand Each of the API Calls Below

size

titlecase

pretty

updated_title_roles

`api_key`

`field`

`text`

📘
Note: Click the Triangles To Expand Each of the API Calls Below

`size`

`titlecase`

`pretty`

`updated_title_roles`