v5

latestOpenAPI 3.0.3raw.githubusercontent.com2024-10-302120469.4 KB
Company Endpoints

/company/search

get/v5/company/search

Query parameters

querystring

An Elasticsearch (v7.7) query. See our underlying Elasticsearch mapping for reference.

sqlstring

A SQL query of the format: SELECT * FROM company WHERE XXX, where XXX is a standard SQL boolean query involving PDL fields. Any use of column selections or the LIMIT keyword will be ignored.

sizeinteger

The number of matched records to return for this query if they exist*. Must be between 1 and 100

frominteger

An offset value for pagination. Can be a number between 0 and 9999. Pagination can be executed up to a maximum of 10,000 records per query. Be sure to use the "total" response field to help discover how many total records exist in the dataset for your query

scroll_tokenstring
Example:104$14.278746

Setting titlecase to true will titlecase any records returned

titlecaseboolean

Setting titlecase to true will titlecase any records returned

prettyboolean

Whether the output should have human-readable indentation.

Headers

Content-Type'application/json'

The content type

Response

Company Found

affiliated_profilesstring[]

A list of company IDs that PDL has flagged as being affiliated and having an association to this company (either parent or child)

alternative_namesstring[]

The list of names associated with this company filtered to ensure data quality

employee_countinteger

The current integer number of employees working at the company.

facebook_urlstring

Primary company facebook

foundedinteger

The founded year of the company

headlinestring

The company's 'headline' summary

idstring

PDL company ID. This is currently non-persistent and generated from the company's primary linkedin username

industry'accounting' | 'airlines/aviation' | 'alternative dispute resolution' | 'alternative medicine' | 'animation' | 'apparel & fashion' | 'architecture & planning' | 'arts and crafts' | 'automotive' | 'aviation & aerospace' | 'banking' | 'biotechnology' | 'broadcast media' | 'building materials' | 'business supplies and equipment' | 'capital markets' | 'chemicals' | 'civic & social organization' | 'civil engineering' | 'commercial real estate' | 'computer & network security' | 'computer games' | 'computer hardware' | 'computer networking' | 'computer software' | 'construction' | 'consumer electronics' | 'consumer goods' | 'consumer services' | 'cosmetics' | 'dairy' | 'defense & space' | 'design' | 'e-learning' | 'education management' | 'electrical/electronic manufacturing' | 'entertainment' | 'environmental services' | 'events services' | 'executive office' | 'facilities services' | 'farming' | 'financial services' | 'fine art' | 'fishery' | 'food & beverages' | 'food production' | 'fund-raising' | 'furniture' | 'gambling & casinos' | 'glass, ceramics, & concrete' | 'government administration' | 'government relations' | 'graphic design' | 'health, wellness and fitness' | 'higher education' | 'hospital & health care' | 'hospitality' | 'human resources' | 'import and export' | 'individual & family services' | 'industrial automation' | 'information services' | 'information technology and services' | 'insurance' | 'international affairs' | 'international trade and development' | 'internet' | 'investment banking' | 'investment management' | 'judiciary' | 'law enforcement' | 'law practice' | 'legal services' | 'legislative office' | 'leisure, travel, & tourism' | 'libraries' | 'logistics and supply chain' | 'luxury goods & jewelry' | 'machinery' | 'management consulting' | 'maritime' | 'market research' | 'marketing and advertising' | 'mechanical or industrial engineering' | 'media production' | 'medical devices' | 'medical practice' | 'mental health care' | 'military' | 'mining & metals' | 'motion pictures and film' | 'museums and institutions' | 'music' | 'nanotechnology' | 'newspapers' | 'non-profit organization management' | 'oil & energy' | 'online media' | 'outsourcing/offshoring' | 'package/freight delivery' | 'packaging and containers' | 'paper & forest products' | 'performing arts' | 'pharmaceuticals' | 'philanthropy' | 'photography' | 'plastics' | 'political organization' | 'primary/secondary education' | 'printing' | 'professional training & coaching' | 'program development' | 'public policy' | 'public relations and communications' | 'public safety' | 'publishing' | 'railroad manufacture' | 'ranching' | 'real estate' | 'recreational facilities and services' | 'religious institutions' | 'renewables & environment' | 'research' | 'restaurants' | 'retail' | 'security and investigations' | 'semiconductors' | 'shipbuilding' | 'sporting goods' | 'sports' | 'staffing and recruiting' | 'supermarkets' | 'telecommunications' | 'textiles' | 'think tanks' | 'tobacco' | 'translation and localization' | 'transportation/trucking/railroad' | 'utilities' | 'venture capital & private equity' | 'veterinary' | 'warehousing' | 'wholesale' | 'wine and spirits' | 'wireless' | 'writing and editing'

Self reported industry -- the enum is from linkedin's standard industries

linkedin_idstring

Primary company linkedin ID

linkedin_urlstring

Primary company linkedin url

namestring

The company's main common name

profilesstring[]

A list of all profiles associated with the company

size'1-10' | '11-50' | '51-200' | '201-500' | '501-1000' | '1001-5000' | '5001-10000' | '10001+'

A range representing the number of people working at the company

summarystring

Company description

tagsstring[]

Tags associated with the company

tickerstring

Company Ticker, (only for public companies)

twitter_urlstring

Primary company twitter url

type'educational' | 'government' | 'nonprofit' | 'private' | 'public'

The type of the company

websitestring

Primary company website