Employee Data
How to call the TripleQLeads Company Employee Enricher API.
This endpoint charges 1 employee daily usage for each employee returned.
You need a company linkedin_id to perform this request, if you have the company url, perform a company enrichment first to extract the linkedin_id and then make this request.
Using the estimated_employee_count gives you a pretty good guess of how many credits it will cost to scrape all the employees at a company.
A cursor is provided to you if employee count is greater than the limit provided, send this back in subsequent requests to fetch all employees.
Example: limit is 100, but company has 400 employees, a cursor will be returned in all requests until no more employees left to scrape.
Request
Method: POST
URL:
https://api.tripleqleads.com/v1/enricher/company/employees
Headers
X-API-KEY
string required
An API Key is required for this endpoint. Don't know where your key is?
Body
company_linkedin_id
string required
The LinkedIn company ID for the company whose employees you want to retrieve.
limit
number required
Number between 1-100
cursor
string
A cursor is returned if there are more results than specified by the limit. It contains internal data about the position of the search request.
If a cursor is provided make subsequent requests to continue fetching the rest of the employees.
Responses
Successful Response
Status: 200 OK
{
"status": "OK",
"data": {
"company_linkedin_id": "string",
"cursor"?: "string",
"employees": [
{
"linkedin_id": "string",
"public_id": "string",
"urn": "string",
"linkedin_url": "string",
"name": "string",
"first_name": "string",
"last_name": "string",
"location": "string",
"headline": "string",
"summary": "string",
"premium": true,
"current_position": {
"company_data": {
"name": "string",
"linkedin_id": "string",
"description": "string",
"industry": "string"
},
"role": "string",
"location": "string",
"tenure_at_role": {
"years": 0,
"months": 0
},
"tenure_at_company": {
"years": 0,
"months": 0
}
}
}
]
}
}
Error Responses
Status Code | Example Response |
---|---|
400 | { "status": "ERROR", "error": "Invalid request payload." } |
401 | { "status": "ERROR", "error": "You are unauthorized to make this request." } |
403 | { "status": "ERROR", "error": "You have exceeded your API allowance." } |
500 | { "status": "ERROR", "error": "Failed to fetch employees." } |
429 | { "status": "ERROR", "error": "You have exceeded your API rate limit." } |
API Key Authentication Error Responses
Employee Data Object
Below is the structure of each employee object returned in the employees
array upon a successful response.
Field | Type | Description |
---|---|---|
linkedin_id | string | LinkedIn numeric ID of the employee. |
public_id | string | LinkedIn public identifier (slug). |
urn | string | LinkedIn URN identifier for the employee. |
linkedin_url | string | Full LinkedIn profile URL for the employee. |
name | string | Full name of the employee. |
first_name | string | First name of the employee. |
last_name | string | Last name of the employee. |
location | string | Employee’s listed location. |
headline | string | Employee’s LinkedIn headline. |
summary | string | Profile summary or about section. |
premium | boolean | Whether the employee is a LinkedIn Premium user. |
current_position | object | Details of the employee’s current position. See Current Position Object. |
Current Position Object
The current_position
field includes:
Field | Type | Description |
---|---|---|
company_data | object | Details about the company. See Company Data Object. |
role | string | Employee’s role or title. |
location | string | Location for the current position. |
tenure_at_role | object | Duration in the current role. |
tenure_at_company | object | Duration at the company overall. |
Tenure Object
Both tenure_at_role
and tenure_at_company
share the same structure:
Field | Type | Description |
---|---|---|
years | number | Years in the role or company. |
months | number | Additional months in the role or company. |
Company Data Object
The company_data
object inside current_position
contains:
Field | Type | Description |
---|---|---|
name | string | Company name. |
linkedin_id | string | LinkedIn numeric ID of the company. |
description | string | Description of the company. |
industry | string | Company’s industry sector. |