Individual Lookup
Break one company's people down by LinkedIn job function, from its LinkedIn URL or its website. Synchronous, returns the counts directly.
POST /job_function_breakdown
Pass a company's LinkedIn URL, its website, or both. If a LinkedIn URL is given it is used and the website is never looked up. If only a website is given, Parvenu first finds the company's LinkedIn page from the website, then runs the breakdown, and returns the LinkedIn URL it found in data.company_linkedin_url.
The response contains a readable summary in data.job_function_breakdown, the largest function in data.job_function_top, and one integer per LinkedIn job function.
Headers
Content-Type
application/json
Body
Send at least one of company_linkedin_url, company_website or domain. If you send a LinkedIn URL and a website, the LinkedIn URL wins.
api_key
string
Your API Key.
company_linkedin_url
string
Optional. Company LinkedIn URL, e.g. https://www.linkedin.com/company/acme. Used first when present.
company_website
string
Optional. Company website, e.g. acme.com. Used only when there is no company_linkedin_url.
domain
string
Optional. Same as company_website; send either one.
Response
The record is under data. See Response Format for the fields every endpoint returns.
company_linkedin_url
The company LinkedIn URL that was used — the one you sent, or the one found from the website.
job_function_top
The largest function, as a string.
job_function_breakdown
Readable summary, one function per line, largest first, e.g. Sales - 3345 people - 20%, ending with a blank line and Charged once per company. The percentage is that function's share of the people counted, not of the company.
headcount
The number of staff with a LinkedIn profile.
function_count_<function>
One integer per function: LinkedIn's 27 job functions slugified, plus function_count_other. A function with nobody counted in it comes back null rather than 0.
credits_used is 0.5 when a breakdown is found from a LinkedIn URL, 0.7 when the LinkedIn page was found from the website, and 0 on a repeat lookup of a company looked up recently. When no LinkedIn page or no breakdown is found, the call still returns HTTP 200, with status not_found and "credits_used": 0.
Example
The website tabs are a lookup by company_website only: Parvenu found the company's LinkedIn page, returned it in company_linkedin_url, and charged 0.7 credits. The repeat-call tab is the same request made again soon after: the data is identical and credits_used is 0. These are trimmed to the fields that make the point — the full field set comes back either way.
A request with none of company_linkedin_url, company_website or domain returns a 422 validation error.
To break down every company in a list in one call instead, use List Lookup.