> ## Documentation Index
> Fetch the complete documentation index at: https://docs.peopledatalabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Output Response - Autocomplete API

## Response Data Structure

### Abridged Response Data Structure

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

```json
{
  "data": [
    {
      "name": "Google",
      "count": 197302,
      "meta": {
        "id": "aKCIYBNF9ey6o5CjHCCO4goHYKlf",
        "website": "google.com",
        "industry": "Internet",
        "location_name": "Mountain View, California, United States",
        "display_name": "Google",
        "display_name_history": [
          "Google"
        ],
        "alternative_names": [
          "\u8c37\u6b4c",
          "Google, Social Marketing Tools",
          "\uad6c\uae00",
          "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

<details>
  <summary>
    Full Output Response (click to expand)
  </summary>

  ```json
  {
    "data": [
      {
        "name": "Google",
        "count": 197302,
        "meta": {
          "id": "aKCIYBNF9ey6o5CjHCCO4goHYKlf",
          "website": "google.com",
          "industry": "Internet",
          "location_name": "Mountain View, California, United States",
          "display_name": "Google",
          "display_name_history": [
            "Google"
          ],
          "alternative_names": [
            "\u8c37\u6b4c",
            "Google, Social Marketing Tools",
            "\uad6c\uae00",
            "Google Inc.",
            "Google Pay",
            "Google, Inc.",
            "Google Deepmind",
            "Google Inc",
            "Google Digital Skills for Africa",
            "Google, Inc"
          ]
        }
      },
      {
        "name": "Google Operations Center",
        "count": 4032,
        "meta": {
          "id": "T0pYt4X5ITzm8Uj41SnuoAbuEQG9",
          "website": "googleoperationscenter.com",
          "industry": "Internet",
          "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": 3705,
        "meta": {
          "id": "cr3tG4Z9VAknYR7HMY35rAaIXxtL",
          "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 Developer Student Clubs",
        "count": 2911,
        "meta": {
          "id": "G0b4fuHWApIrWFIg8Yw3AQlChpWJ",
          "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 Adsense",
        "count": 2105,
        "meta": {
          "id": "96xZ8JtUnvLnlB8jpFGrsgH2q6OY",
          "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": 1934,
        "meta": {
          "id": "StyaWCIGgDNCuBaCNAhGWwCKPEQb",
          "website": "deepmind.google",
          "industry": "Research",
          "location_name": "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"
          ]
        }
      },
      {
        "name": "Mandiant",
        "count": 1522,
        "meta": {
          "id": "yWcH1EiAH4BCKHMSP57f6wRIccqa",
          "website": "mandiant.com",
          "industry": "Computer & Network Security",
          "location_name": "Reston, Virginia, United States",
          "display_name": "Mandiant",
          "display_name_history": [
            "Mandiant (now part of Google Cloud)",
            "Mandiant"
          ],
          "alternative_names": [
            "Mandiant (Now Part of Google Cloud)",
            "Mandiant, a Fireeye Company",
            "Mandiant a Fireeye Company",
            "Mandiant (Acquired by Fireeye)",
            "Mandiant / Fireeye",
            "Mandiant, a Division of Fireeye",
            "Mandiant Security Consulting",
            "Mandiant Threat Intelligence",
            "Fireeye/Mandiant",
            "Mandiant Corporation"
          ]
        }
      },
      {
        "name": "Developer Students",
        "count": 1073,
        "meta": {
          "id": "fUCW2Lc4PFzqyOCuuxtPlQhpN53H",
          "website": "developers.google.com/community/dsc",
          "industry": "Education Management",
          "location_name": "San Francisco, California, United States",
          "display_name": "Developer Students",
          "display_name_history": [
            "Developer Students",
            "Google Developer Student Clubs",
            "Developer Student Clubs"
          ],
          "alternative_names": [
            "Google Developer Student Clubs",
            "Developer Student Clubs",
            "Google Developer Student Clubs (Canada & Usa)",
            "Developer Student Clubs - North America",
            "Developer Student Clubs - Na",
            "Google Developer Student Clubs #Developerstudentclubs",
            "Developers",
            "Google Developper Student Club",
            "Developer Student Clubs - Qmul",
            "Developer Student Clubs - Amity University, Noida."
          ]
        }
      },
      {
        "name": "Google Developers",
        "count": 941,
        "meta": {
          "id": "rXDaaEKS6y8krSdQQFuqfwvAVJmy",
          "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": "Google Developers Group",
        "count": 814,
        "meta": {
          "id": "1U34ahOyq403GKx9nKM5yQuYs39E",
          "website": "developers.google.com/groups",
          "industry": "Computer Software",
          "display_name": "Google Developers Group",
          "display_name_history": [
            "Google Developers Group"
          ],
          "alternative_names": [
            "Google Developers Group Culiac\u00e1n (Comunidad)",
            "Google Developers",
            "Google",
            "Google Developers Group, Bhubaneshwar",
            "Self-Employed",
            "Google Developers Group 6 October",
            "Google Developers Group - Houston",
            "Google Developers Groups",
            "Google Developers Group Agadir",
            "Google Developers Group Mysuru"
          ]
        }
      }
    ],
    "fields": [
      "job_company_name",
      "experience.company.name"
    ],
    "status": 200
  }
  ```
</details>

## Response Fields

### `fields`

| Type             | Description                                                                                                                                                                                                                                                                         |
| :--------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Array (String)` | The list of fields in the [Person Schema](https://docs.peopledatalabs.com/docs/fields) that the Autocomplete API has returned suggestions for. It determines these based on the value that you used for the [`field` input parameter](https://docs.peopledatalabs.com/docs/input-parameters-autocomplete-api#field). |

See the [`field` input parameter description](https://docs.peopledatalabs.com/docs/input-parameters-autocomplete-api#field) for the mapping between Autocomplete API fields and Person Schema fields.

<br />

### `data`

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>
        Type
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `Array (Object)`
      </td>

      <td>
        The list of suggestions that the Autocomplete API has returned.

        It sorts results in descending order based on `data.count`. The [`size` input parameter](https://docs.peopledatalabs.com/docs/input-parameters-autocomplete-api#size) determines the size of the list.
      </td>
    </tr>
  </tbody>
</Table>

<br />

### `data.count`

| Type      | Description                                                                                                                                       |
| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Integer` | The number of records in our [Person Dataset (resume slice)](https://docs.peopledatalabs.com/docs/resume-stats) for this Autocomplete suggestion. |

<br />

### `data.name`

| Type     | Description                                                                                                                                                                                                                                       |
| :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `String` | The 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](https://docs.peopledatalabs.com/docs/input-parameters-autocomplete-api#text). |

<br />

### `data.meta.*`

| Type     | Description                                                                                                                                                                                                                   |
| :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Object` | A set of additional fields that the API returns for each result in the data array. The metadata fields depend on the [`field` input parameter](https://docs.peopledatalabs.com/docs/input-parameters-autocomplete-api#field). |

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`](https://docs.peopledatalabs.com/docs/input-parameters-autocomplete-api#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 Field         | Type             | Description                                                                  | Example                                    |
| ---------------------- | ---------------- | ---------------------------------------------------------------------------- | ------------------------------------------ |
| `id`                   | `String`         | The PDL ID for this company.                                                 | `tnHcNHbCv8MKeLh92946LAkX6PKg`             |
| `website`              | `String`         | The website associated with this company.                                    | `peopledatalabs.com`                       |
| `industry`             | `Enum (String)`  | The most relevant [industry](https://docs.peopledatalabs.com/docs/industries)  for this company.              | `internet`                                 |
| `location_name`        | `String`         | The name of the most relevant location for this company.                     | `san francisco, california, united states` |
| `display_name`         | `String`         | The company name, capitalized using the company’s self-reported name.        | `People Data Labs`                         |
| `display_name_history` | `Array [String]` | A list of the company’s historical primary names with proper capitalization. | `["People Data Labs"]`                     |
| `alternative_names`    | `Array [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 Field | Type | Description | Example |
| -------------- | ---- | ----------- | ------- |
| None           | --   | --          | --      |

#### Metadata Fields for Industry

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

| Metadata Field | Type | Description | Example |
| -------------- | ---- | ----------- | ------- |
| None           | --   | --          | --      |

#### Metadata Fields for Location

*The metadata fields that the API returns when`field = "location_name"` in the input parameters:*

| Metadata Field | Type            | Description                                                                        | Example                 |
| -------------- | --------------- | ---------------------------------------------------------------------------------- | ----------------------- |
| `country`      | `Enum (String)` | The [country](https://docs.peopledatalabs.com/docs/location-countries) of this location.                            | `united states`         |
| `locality`     | `String`        | The locality of this location.                                                     | `san francisco`         |
| `metro`        | `String`        | The metro associated with this location. **Only returned for US-based locations.** | `san diego, california` |
| `region`       | `String`        | The region of this location.                                                       | `california`            |

#### Metadata Fields for Major

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

| Metadata Field | Type | Description | Example |
| -------------- | ---- | ----------- | ------- |
| None           | --   | --          | --      |

#### Metadata Fields for Region

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

| Metadata Field | Type | Description | Example |
| -------------- | ---- | ----------- | ------- |
| None           | --   | --          | --      |

#### Metadata Fields for Role

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

| Metadata Field | Type | Description | Example |
| -------------- | ---- | ----------- | ------- |
| None           | --   | --          | --      |

#### Metadata Fields for Sub\_Role

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

| Metadata Field | Type            | Description                                                                                                                                  | Example       |
| -------------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| `role`         | `Enum (String)` | The role associated with this subrole (see [Mapping Title Subroles to Roles](https://docs.peopledatalabs.com/docs/title-subroles-to-roles).) | `engineering` |

#### Metadata Fields for Class

*The metadata fields that the API returns when`field = "class"` in the input parameters:*

| Metadata Field | Type | Description | Example |
| -------------- | ---- | ----------- | ------- |
| None           | --   | --          | --      |

#### Metadata Fields for School

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

| Metadata Field  | Type     | Description                                             | Example                                  |
| --------------- | -------- | ------------------------------------------------------- | ---------------------------------------- |
| `location_name` | `String` | The name of the most relevant location for this school. | `eugene, oregon, united states`          |
| `website`       | `String` | The website associated with this school.                | `business.uoregon.edu`                   |
| `id`            | `String` | The 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 Field | Type | Description | Example |
| -------------- | ---- | ----------- | ------- |
| None           | --   | --          | --      |

#### Metadata Fields for Title

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

| Metadata Field | Type | Description | Example |
| -------------- | ---- | ----------- | ------- |
| None           | --   | --          | --      |

#### Metadata Fields for Website

*The metadata fields that the API returns when`field = "website"` in the input parameters:*

| Metadata Field         | Type             | Description                                                                  | Example                                    |
| ---------------------- | ---------------- | ---------------------------------------------------------------------------- | ------------------------------------------ |
| `id`                   | `String`         | The PDL ID for this company.                                                 | `tnHcNHbCv8MKeLh92946LAkX6PKg`             |
| `website`              | `String`         | The website associated with this company.                                    | `peopledatalabs.com`                       |
| `industry`             | `Enum (String)`  | The most relevant [industry](https://docs.peopledatalabs.com/docs/industries)  for this company.              | `internet`                                 |
| `location_name`        | `String`         | The name of the most relevant location for this company.                     | `san francisco, california, united states` |
| `display_name`         | `String`         | The company name, capitalized using the company’s self-reported name.        | `People Data Labs`                         |
| `display_name_history` | `Array [String]` | A list of the company’s historical primary names with proper capitalization. | `["People Data Labs"]`                     |
| `alternative_names`    | `Array [String]` | A list of other names associated with this company.                          | `[]`                                       |

<br />

### `status`

| Type      | Description                                                           |
| :-------- | :-------------------------------------------------------------------- |
| `Integer` | The [API response code](https://docs.peopledatalabs.com/docs/errors). |