Employee Listing Endpoint

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Query 参数

coy_name_match

string

可选

Include profiles that match the company name. The Employee Listing Endpoint works by identifying individual profiles with work experience that provides an exact match to the LinkedIn Company Profile URL provided. Including this option also allows profiles with at least one work experience that exactly matches the specified company name to be included.

This parameter accepts the following values:

include (default value) - Include employees whose profiles match the company name.

exclude - Exclude employees by company name match.

示例值:

include

use_cache

string

可选

Define the freshness guarantee on the results returned.

This parameter accepts the following values:

if-present (default value) - Returns result as it is without any freshness guarantee

if-recent - Will make a best effort to return results of profiles no older than 29 days. Costs 1 extra credit per result on top of the base cost of the endpoint for users on the Growth or larger subscription. For all other users, it will cost 2 extra credits per result on top of the base cost of the endpoint.

Note: If use_cache=if-recent, page_size is limited to a value of 10 or smaller.

示例值:

if-present

country

string

可选

Limit the result set to the country locality of the profile. For example, set the parameter of country=us if you only want profiles from the US. Or you can set the parameter to country=us,sg if you want employees from both the US and Singapore.

This parameter accepts a comma-separated case-insensitive values of Alpha-2 ISO3166 country code.

Costs an extra 3 credit per result returned.

示例值:

enrich_profiles

string

可选

Get the full profile of employees instead of only their profile urls.

Each request respond with a streaming response of profiles.

The valid values are:

skip (default): lists employee's profile url

enrich: lists full profile of employees

Calling this API endpoint with this parameter would add 1 credit per employee returned.

示例值:

enrich

role_search

string

可选

Filter employees by their title by matching the employee's title against a regular expression.

The default value of this parameter is null.

The accepted value for this parameter is a case-insensitive regular expression.

(The base cost of calling this API endpoint with this parameter would be 10 credits.
Each employee matched and returned would cost 3 extra credits.)

示例值:

(co)?-?founder

page_size

string

可选

Limit the maximum results returned per API call.

The default value of this parameter is 10.

Accepted values for this parameter is an integer ranging from 1 to 200000.

When enrich_profiles=enrich, this parameter accepts value ranging from 1 to 10 and the default value is 10.

示例值:

employment_status

string

可选

Parameter to tell the API to return past or current employees.

Valid values are current, past, and all:

current (default) : lists current employees

past : lists past employees

all : lists current & past employees

示例值:

current

sort_by

string

可选

Sort employees by recency.

Valid values are:

recently-joined - Sort employees by their join date. The most recent employee is on the top of the list.

recently-left - Sort employees by their departure date. The most recent employee who had just left is on the top of this list.

oldest - Returns the oldest employees first. The oldest employee who had joined this company historically is on the top of this list.

none - The default value. Do not sort.

If this parameter is supplied with a value other than none, will add 50 credits to the base cost of the API endpoint regardless number of results returned. It will also add an additional cost of 10 credits per employee returned.

示例值:

recently-joined

resolve_numeric_id

string

可选

Enable support for Company Profile URLs with numerical IDs that you most frequently fetch from Sales Navigator.
We achieve this by resolving numerical IDs into vanity IDs with cached company profiles from LinkDB.
For example, we will turn https://www.linkedin.com/company/1234567890 to https://www.linkedin.com/company/acme-corp -- for which the API endpoint only supports the latter.

This parameter accepts the following values:

false (default value) - Will not resolve numerical IDs.

true - Enable support for Company Profile URLs with numerical IDs.
Costs an extra 2 credit on top of the base cost of the endpoint.

示例值:

false

url

string

必需

URL of the LinkedIn Company Profile to target.

URL should be in the format of https://www.linkedin.com/company/<public_identifier>

示例值:

https://www.linkedin.com/company/microsoft

返回响应

🟢200成功

application/json

List of employees

Body

employees

array[object (Employee) {3}]

可选

A list of employee profiles (if enriched) and their associated profile URL.

profile_url

string

可选

LinkedIn Profile URL of the employee.

profile

可选

last_updated

string | null

可选

ISO 8601 timestamp since the enriched profile was last scraped.

next_page

string | null

可选

The API URI that will lead to the next page of results. This will be null for the final page.

示例

{
    "employees": [
        {
            "profile_url": "https://www.linkedin.com/in/williamhgates",
            "profile": {
                "public_identifier": "williamhgates",
                "profile_pic_url": "https://media.licdn.com/dms/image/C5616AQH9tkBTUhHfng/profile-displaybackgroundimage-shrink_200_800/0/1614530499015?e=2147483647&v=beta&t=VEoCyedtZulnAVYWT9BXfKHi5OFp8avElNjiz8kjSTU",
                "background_cover_image_url": null,
                "first_name": "Bill",
                "last_name": "Gates",
                "full_name": "Bill Gates",
                "occupation": "Co-chair at Bill & Melinda Gates Foundation",
                "headline": "Co-chair, Bill & Melinda Gates Foundation",
                "summary": "Co-chair of the Bill & Melinda Gates Foundation. Founder of Breakthrough Energy. Co-founder of Microsoft. Voracious reader. Avid traveler. Active blogger.",
                "country": "US",
                "country_full_name": "United States of America",
                "city": "Seattle",
                "state": "Washington",
                "experiences": [
                    {
                        "starts_at": {
                            "day": 1,
                            "month": 1,
                            "year": 2015
                        },
                        "ends_at": null,
                        "company": "Breakthrough Energy ",
                        "company_linkedin_profile_url": "https://www.linkedin.com/company/breakthrough-energy/",
                        "title": "Founder",
                        "description": null,
                        "location": null,
                        "logo_url": "https://media-exp1.licdn.com/dms/image/C4D0BAQGwD9vNu044FA/company-logo_400_400/0/1601560874941?e=1672876800&v=beta&t=VKb6OAHEwlnazKYKm4fc9go-y4zkUv2BT6tosOdQ54Y"
                    },
                    {
                        "starts_at": {
                            "day": 1,
                            "month": 1,
                            "year": 2000
                        },
                        "ends_at": null,
                        "company": "Bill & Melinda Gates Foundation",
                        "company_linkedin_profile_url": "https://www.linkedin.com/company/bill-&-melinda-gates-foundation/",
                        "title": "Co-chair",
                        "description": null,
                        "location": null,
                        "logo_url": "https://media-exp1.licdn.com/dms/image/C4E0BAQE7Na_mKQhIJg/company-logo_400_400/0/1633731810932?e=1672876800&v=beta&t=Mz_ntwD4meCMcgo1L3JqDxBQRabFLIesd0Yz2ciAXNs"
                    }
                ],
                "education": [
                    {
                        "starts_at": {
                            "day": 1,
                            "month": 1,
                            "year": 1973
                        },
                        "ends_at": {
                            "day": 31,
                            "month": 12,
                            "year": 1975
                        },
                        "field_of_study": null,
                        "degree_name": null,
                        "school": "Harvard University",
                        "school_linkedin_profile_url": null,
                        "description": null,
                        "logo_url": "https://media-exp1.licdn.com/dms/image/C4E0BAQF5t62bcL0e9g/company-logo_400_400/0/1519855919126?e=1672876800&v=beta&t=9twXof1JlnNHfFprrDMi-C1Kp55HTT4ahINKHRflUHw"
                    },
                    {
                        "starts_at": null,
                        "ends_at": null,
                        "field_of_study": null,
                        "degree_name": null,
                        "school": "Lakeside School",
                        "school_linkedin_profile_url": null,
                        "description": null,
                        "logo_url": "https://media-exp1.licdn.com/dms/image/C4D0BAQENlfOPKBEk3Q/company-logo_400_400/0/1519856497259?e=1672876800&v=beta&t=v7nJTPaJMfH7WOBjb22dyvNKxAgdPdVd8uLCUkMB1LQ"
                    }
                ],
                "languages": [],
                "accomplishment_organisations": [],
                "accomplishment_publications": [],
                "accomplishment_honors_awards": [],
                "accomplishment_patents": [],
                "accomplishment_courses": [],
                "accomplishment_projects": [],
                "accomplishment_test_scores": [],
                "volunteer_work": [],
                "certifications": [],
                "connections": null,
                "people_also_viewed": [],
                "recommendations": [],
                "activities": [],
                "similarly_named_profiles": [],
                "articles": [],
                "groups": []
            },
            "last_updated": "2023-10-26T11:34:30Z"
        }
    ],
    "next_page": null
}

🟠400请求有误

🟠401没有权限

🟠403禁止访问

🟠404记录不存在

🟠429429

🔴500服务器错误

🔴503服务器故障

请求参数

示例代码

返回响应