Output Response - Company Search API

Detailed information on the output response that the Company Search API returns

Response Data Structure

Abridged Response Data Structure

Here is an example response from the Company Search API:

{
    "status": 200,
    "data": [
        {
            "id": "google",
            "name": "google",
            "website": "google.com",
            ...
        },
        ...
    ],
    "total": 6,
    "scroll_token": "13.312621$543927"
}

Full Example Response

Full Output Response (click to expand)
{
  "status": 200,
  "data": [
    {
      "id": "peopledatalabs",
      "website": "peopledatalabs.com",
      "name": "people data labs",
      "founded": 2015,
      "size": "11-50",
      "location": {
        "name": "san francisco, california, united states",
        "locality": "san francisco",
        "region": "california",
        "metro": "san francisco, california",
        "country": "united states",
        "continent": "north america",
        "street_address": "455 market street",
        "address_line_2": "suite 1670",
        "postal_code": "94105",
        "geo": "37.77,-122.41"
      },
      "industry": "computer software",
      "facebook_url": "facebook.com/peopledatalabs",
      "twitter_url": "twitter.com/peopledatalabs",
      "linkedin_url": "linkedin.com/company/peopledatalabs",
      "linkedin_id": "18170482",
      "email_domains": [],
      "ticker": null,
      "type": "private",
      "profiles": [
        "linkedin.com/company/peopledatalabs",
        "linkedin.com/company/18170482",
        "facebook.com/peopledatalabs",
        "twitter.com/peopledatalabs",
        "crunchbase.com/organization/talentiq"
      ],
      "tags": [
        "data",
        "people data",
        "data science",
        "artificial intelligence",
        "data and analytics",
        "machine learning",
        "analytics",
        "database",
        "software",
        "developer apis"
      ],
      "summary": "people data labs builds people data. \n\nuse our dataset of 1.5 billion unique person profiles to build products, enrich person profiles, power predictive modeling/ai, analysis, and more. we work with technical teams as their engineering focused people data partner. \n\nwe work with thousands of data science teams as their engineering focused people data partner. these include enterprises like adidas, ebay, and acxiom, as well as startups like madison logic, zoho, and workable. we are a deeply technical company, and are backed by two leading engineering venture capital firms - founders fund and 8vc.",
      "headline": "Your Single Source of Truth",
      "alternative_names": [],
      "alternative_domains": [],
      "affiliated_profiles": []
    }
  ],
  "scroll_token": "13.312621$5439277"
  "total": 6
}

Response Fields

data.*

TypeDescription
ObjectThe matched profile in the format described in our Company Schema.

The data object contains the entire PDL profile for the company that matches the Search API request. Any profile field that we do not have data for will have a null value.


error

TypeDescription
ObjectThe error object. See Errors page.

error.type

TypeDescription
List (String)The error type.

error.message

TypeDescription
StringThe error message.

status

TypeDescription
IntegerThe API response code.

total

TypeDescription
IntegerThe total number of records that matched the input query.

scroll_token

TypeDescription
StringThe scroll token to use to fetch the next batch of results for the query.

For more information on using scroll_token, see here.