The Enrich Layer connector lets your AI agent act in each user's Enrich Layer account. Each user connects their own Enrich Layer access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 21 tools.
- Tools
- 21
- What they doRead · write · destructive
- 5 · 16 · 05 read16 write0 destructive
- Users sign in with
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Enrich Layer connection
In AgentKit > Connections, create an Enrich Layer connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'enrichlayer'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Enrich Layer:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'enrichlayer_credit_balance_get',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "enrichlayer"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Enrich Layer:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="enrichlayer_credit_balance_get",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Enrich Layer credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolenrichlayer_company_id_lookupGet a company's vanity (public) ID from its numeric LinkedIn ID.Read-onlyLook Up Company Vanity ID
Get a company's vanity (public) ID from its numeric LinkedIn ID. Free (0 credits). Returns the vanity ID and profile URL. Use enrichlayer_company_id_lookup to turn a numeric company ID into a URL for enrichlayer_company_profile_get.
Inputs
idstringrequired- The company's internal, immutable numeric ID. Example: 1441
enrichlayer_company_profile_picture_getGet the profile picture (logo) URL of a company from cached profiles.Read-onlyGet Company Logo
Get the profile picture (logo) URL of a company from cached profiles. Free (0 credits). Returns a temporary image URL. Use enrichlayer_company_profile_picture_get for a logo. Use enrichlayer_company_profile_get for full company data.
Inputs
company_profile_urlstringrequired- Profile URL of the company that you are trying to get the profile picture of. Example: https://www.linkedin.com/company/apple/
enrichlayer_credit_balance_getGet the account's remaining Enrich Layer credit balance.Read-onlyGet Credit Balance
Get the account's remaining Enrich Layer credit balance. Free (0 credits). Returns credit_balance. Use enrichlayer_credit_balance_get to check the connection and remaining credits before costly searches.
Inputs
This tool takes no inputs.
enrichlayer_disposable_email_checkCheck whether an email address belongs to a disposable (throwaway) email service.Read-onlyCheck Disposable Email
Check whether an email address belongs to a disposable (throwaway) email service. Free (0 credits). Returns is_disposable_email and is_free_email. Use enrichlayer_disposable_email_check to screen sign-ups or leads.
Inputs
emailstringrequired- Email address to check. Example: steven@nubela.co
enrichlayer_person_profile_picture_getGet the profile picture URL of a person from cached profiles.Read-onlyGet Person Profile Picture
Get the profile picture URL of a person from cached profiles. Free (0 credits). Returns a temporary image URL. Use enrichlayer_person_profile_picture_get for an avatar. Use enrichlayer_person_profile_get for the full profile.
Inputs
person_profile_urlstringrequired- Profile URL of the person that you are trying to get the profile picture of. Example: https://www.linkedin.com/in/williamhgates/
enrichlayer_company_employee_count_getGet the number of employees of a company, from Enrich Layer's dataset and the company's own stated count.WriteGet Company Employee Count
Get the number of employees of a company, from Enrich Layer's dataset and the company's own stated count. Costs 1 credit per successful request. Returns the employee count by source. Use enrichlayer_company_employee_count_get for headcount. Use enrichlayer_company_employees_list for the people.
- Idempotent
Inputs
urlstringrequired- URL of the Company Profile to target. Example: https://www.linkedin.com/company/google/
at_datestring- Time travel back in time and fetch the employee count of a company at any particular date. This parameter takes an ISO8601 timestamp with the representation of "YYYY-MM-DD". Costs 1 extra credit on top of the base cost of the endpoint for users on the Growth or larger subscription. For all other users, it will cost 5 extra credits. Example: 2023-12-31
coy_name_matchstring- Include profiles that match the company name. The Employee Count Endpoint works by identifying individual profiles with work experience that provides an exact match to the 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. Example: include
employment_statusstring- Parameter to tell the API to filter past or current employees. Valid values are current, past, and all: * current (default) : count current employees * past : count past employees * all : count current & past employees. Example: current
estimated_employee_countstring- Option to include a retrieved employee count value from the target company's profile. Valid values are include and exclude: * exclude (default) : To exclude the retrieved employee count. * include : To include the retrieved employee count. Costs an extra 1 credit on top of the base cost of the endpoint. Example: include
use_cachestring- if-present: The default behavior. Fetches data from cache regardless of age of profile. if-recent: API will make a best effort to return a fresh data no older than 29 days. Costs an extra 1 credit on top of the cost of the base endpoint. - Note: When use_cache=if-recent, the estimated_employee_count parameter must be included with a value of 'include'. Example: if-present
enrichlayer_company_employee_searchSearch a company's employees by job title with a boolean keyword expression.WriteSearch Company Employees
Search a company's employees by job title with a boolean keyword expression. Costs 10 credits per successful request. Returns matching employee profile URLs (or enriched profiles) and a next_page link. Use enrichlayer_company_employee_search to find people with a title at one company. Use enrichlayer_role_lookup for the single best match for a role.
- Idempotent
Inputs
company_profile_urlstringrequired- Profile URL of the target company. Example: https://www.linkedin.com/company/microsoft/
keyword_booleanstringrequired- Job title keyword to search for in Boolean Search Syntax format. This parameter will take precedence over keyword_regex parameter if both are provided. The value provided for this parameter must not exceed 255 characters. This parameter is case-insensitive; matching ignores capitalization in both the input and our data. Example: ceo OR cto
countrystring- 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. This parameter accepts a case-insensitive Alpha-2 ISO3166 country code. Costs an extra 3 credit per result returned. Example: US
enrich_profilesstring- 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. Example: skip
keyword_regexstring- Use keyword_boolean instead. Job title keyword to search for in regular expression format. The accepted value for this parameter is a case-insensitive regular expression. Example: ceo|cto
page_sizestring- Tune 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 9999. When enrich_profiles=enrich, this parameter accepts value ranging from 1 to 10 and the default value is 10. Example: 10
resolve_numeric_idstring- Enable support for Company Profile URLs with numerical IDs. 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. Example: false
enrichlayer_company_employees_listList people who work or worked at a company, optionally by country, role and employment status.WriteList Company Employees
List people who work or worked at a company, optionally by country, role and employment status. Costs 3 credits per employee returned, plus 1 credit per profile when enrich_profiles is set. Returns a page of employee profile URLs (or full profiles when enriched) and a next_page link. Use enrichlayer_company_employees_list to map a company's staff. Use enrichlayer_company_employee_search to search by job title only.
- Idempotent
Inputs
urlstringrequired- URL of the Company Profile to target. Example: https://www.linkedin.com/company/google/
afterstring- The cursor for fetching the next page of results. Take the value of the after query parameter from the next_page URL of the previous response. Example: ACoAABcmFr4BDtg4nVHvYZRUKeB6m5ELt0y9yuM
boolean_role_searchstring- Filter employees by their title using boolean search expression. This parameter will take precedence over role_search parameter if both are provided. The default value of this parameter is null. The value provided for this parameter must follow Boolean Search Syntax. It must not exceed 255 characters. This parameter is case-insensitive; matching ignores capitalization in both the input and our data. (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.). Example: "founder" OR "co-founder" OR "cofounder"
countrystring- 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. Example: US
coy_name_matchstring- 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 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. Example: include
employment_statusstring- 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. Example: current
enrich_profilesstring- 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. Employee that is returned without enrichment won't incur any per employee cost. Example: skip
page_sizestring- 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 9999. When enrich_profiles=enrich, this parameter accepts value ranging from 1 to 10 and the default value is 10. Example: 10
resolve_numeric_idstring- Enable support for Company Profile URLs with numerical IDs. 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. Example: false
role_searchstring- Use boolean_role_search instead. 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 provided regex patern must follow Lucene Regular Expression Syntax. The regular expression is anchored to the start and end of the provided pattern by default. You need to wrap your pattern accordingly if you want to perform a partial match. (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.). Example: (co)?-?founder
sort_bystring- 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. Example: recently-joined
use_cachestring- 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.*. Example: if-present
enrichlayer_company_jobs_count_getCount the job postings of a company with the same filters as enrichlayer_company_jobs_search.WriteCount Company Jobs
Count the job postings of a company with the same filters as enrichlayer_company_jobs_search. Costs 2 credits per request. Returns the number of matching jobs. Use enrichlayer_company_jobs_count_get for a hiring volume signal. Use enrichlayer_company_jobs_search for the postings.
- Idempotent
Inputs
experience_levelstring- The experience level needed for the job. It accepts the following 6 case-insensitive values only: - internship - entry_level - associate - mid_senior_level - director - anything (default). Example: mid_senior_level
flexibilitystring- The flexibility of the job. It accepts the following 3 case insensitive values only: - remote - on-site - hybrid - anything (default). Example: remote
geo_idstring- The geo_id of the location to search for. For example, 92000000 is the geo_id of world wide. Example: 92000000
job_typestring- The nature of the job. It accepts the following 7 case-insensitive values only: - full-time - part-time - contract - internship - temporary - volunteer - anything (default). Example: full-time
keywordstring- The keyword to search for. Example: software engineer
search_idstring- The search_id of the company. You can get the search_id of a company via Company Profile API. Example: 1035
whenstring- The time when the job is posted, It accepts the following case-insensitive values only: - yesterday - past-week - past-month - anytime (default). Example: past-month
enrichlayer_company_jobs_searchList job postings of a company, filtered by job type, experience level, posting date, flexibility, location and keyword.WriteSearch Company Jobs
List job postings of a company, filtered by job type, experience level, posting date, flexibility, location and keyword. Costs 2 credits per request. Returns a page of jobs with title, location, posting date and job URL, plus a next_page_api_url. Use enrichlayer_company_jobs_search to see who a company is hiring. Use enrichlayer_company_jobs_count_get for the total only.
- Idempotent
Inputs
experience_levelstring- The experience level needed for the job. It accepts the following 6 case-insensitive values only: - internship - entry_level - associate - mid_senior_level - director - anything (default). Example: mid_senior_level
flexibilitystring- The flexibility of the job. It accepts the following 3 case insensitive values only: - remote - on-site - hybrid - anything (default). Example: remote
geo_idstring- The geo_id of the location to search for. For example, 92000000 is the geo_id of world wide. Example: 92000000
job_typestring- The nature of the job. It accepts the following 7 case-insensitive values only: - full-time - part-time - contract - internship - temporary - volunteer - anything (default). Example: full-time
keywordstring- The keyword to search for. Example: software engineer
paginationstring- The token for fetching the next page of results. Take the value of the pagination query parameter from the next_page_api_url of the previous response. Example: eyJwYWdlIjogMX0=
search_idstring- The search_id of the company. You can get the search_id of a company via Company Profile API. Example: 1035
whenstring- The time when the job is posted, It accepts the following case-insensitive values only: - yesterday - past-week - past-month - anytime (default). Example: past-month
enrichlayer_company_lookupFind a company's profile URL from its name, domain or location.WriteLook Up Company
Find a company's profile URL from its name, domain or location. Costs 2 credits on any 200 response, even without a match. Returns the best matching company profile URL and, when requested, the enriched profile. Use enrichlayer_company_lookup when you have a name or website. Use enrichlayer_company_profile_get once you have the URL.
- Idempotent
Inputs
company_domainstring- Company website or Company domain Requires either company_domain or company_name. Example: accenture.com
company_locationstring- The location / region of company. ISO 3166-1 alpha-2 codes. Example: sg
company_namestring- Company Name Requires either company_domain or company_name. Example: Accenture
enrich_profilestring- Enrich the result with a cached profile of the lookup result. The valid values are: * skip (default): do not enrich the results with cached profile data * enrich: enriches the result with cached profile data Calling this API endpoint with this parameter would add 1 credit. If you require fresh profile data, please chain this API call with the Company Profile Endpoint with the use_cache=if-recent parameter. Example: skip
enrichlayer_company_profile_getGet structured data of a company profile from its LinkedIn company URL.WriteGet Company Profile
Get structured data of a company profile from its LinkedIn company URL. Costs 1 credit per successful request, plus extra credits for each optional add-on. Returns name, description, website, industry, size, headquarters, locations, specialties and, when requested, categories, funding, exits, acquisitions and extra details. Use enrichlayer_company_profile_get when you have the company URL. Use enrichlayer_company_lookup to find it from a name or domain.
- Idempotent
Inputs
urlstringrequired- URL Company Profile to crawl. Example: https://www.linkedin.com/company/google/
acquisitionsstring- Provides further enriched data on acquisitions made by this company from external sources. Default value is "exclude". The other acceptable value is "include", which will include these acquisition data (if available) for 1 extra credit. Example: include
categoriesstring- Appends categories data of this company. Default value is "exclude". The other acceptable value is "include", which will include these categories (if available) for 1 extra credit. Example: include
exit_datastring- Returns a list of investment portfolio exits. Default value is "exclude". The other acceptable value is "include", which will include these categories (if available) for 1 extra credit. Example: include
extrastring- Enriches the Company Profile with extra details from external sources. Details include Crunchbase ranking, contact email, phone number, Facebook account, Twitter account, funding rounds and amount, IPO status, investor information, etc. Default value is "exclude". The other acceptable value is "include", which will include these extra details (if available) for 1 extra credit. Example: include
fallback_to_cachestring- Tweaks the fallback behavior if an error arises from fetching a fresh profile. This parameter accepts the following values: * on-error (default value) - Fallback to reading the profile from cache if an error arises. * never - Do not ever read profile from cache. Example: on-error
funding_datastring- Returns a list of funding rounds that this company has received. Default value is "exclude". The other acceptable value is "include", which will include these categories (if available) for 1 extra credit. Example: include
live_fetchstring- Tweak the behavior of the API to fetch the fresh profile. This parameter accepts the following values: * force - Force the API to fetch the fresh profile. Costs an extra 9 credits on top of the cost of the base endpoint. * default (default value) - Do not force the API to fetch the fresh profile. Consider using use_cache instead. Example: default
use_cachestring- if-present - Fetches profile from cache regardless of age of profile. If profile is not available in cache, API will attempt to source profile externally. if-recent (Default) - API will make a best effort to return a fresh profile no older than 29 days. Costs an extra 1 credit on top of the cost of the base endpoint. Example: if-present
enrichlayer_company_searchSearch Enrich Layer's company dataset by location, type, size, industry, description, founding year, funding, name or domain, using boolean search expressions.WriteSearch Companies
Search Enrich Layer's company dataset by location, type, size, industry, description, founding year, funding, name or domain, using boolean search expressions. Costs 3 credits per company returned (plus 1 per enriched profile). Returns a page of company profile URLs (or enriched profiles), a next_page token and the total result count. Use enrichlayer_company_search to build target account lists. Use enrichlayer_company_lookup to find one known company.
- Idempotent
Inputs
citystring- Filter companies based in cities matching the provided search expression. Example: "Los Angeles"
countrystring- Filter companies with an office based in this country. This parameter accepts a case-insensitive Alpha-2 ISO3166 country code. Example: US
descriptionstring- Filter companies with a description matching the provided search expression. Example: navy or naval
domain_namestring- Filter companies with a domain name matching the provided search expression. Example: pfizer.com
employee_count_categorystring- Filter companies based on their employee count category. This parameter will take precedence over employee_count_min and employee_count_max parameters. The valid values are: - custom (default): uses employee_count_min and employee_count_max parameters - startup: 1-10 employees - small: 11-50 employees - medium: 51-250 employees - large: 251-1000 employees - enterprise: 1001+ employees. Example: startup
employee_count_maxstring- Filter companies with at most this many employees. Example: 1000
employee_count_minstring- Filter companies with at least this many employees. Example: 100
enrich_profilesstring- Get the company's complete profile data rather than just the URLs to their profiles. Each request respond with a streaming response of profiles. The valid values are: - skip (default): lists company's profile url - enrich: include company's profile data in the list Calling this API endpoint with this parameter would add 1 credit per enriched result returned. Example: skip
follower_count_maxstring- Filter companies with a follower count less than this value. Example: 10000
follower_count_minstring- Filter companies with a follower count of more than this value. Example: 1000
founded_after_yearstring- Filter companies founded after this year. Example: 1985
founded_before_yearstring- Filter companies founded before this year. Example: 2015
funding_amount_maxstring- Filter companies that have raised at most this much (USD) funding amount. Example: 1000000
funding_amount_minstring- Filter companies that have raised at least this much (USD) funding amount. Example: 1000000
funding_raised_afterstring- Filter companies that have raised funding after this date. Example: 2019-12-30
funding_raised_beforestring- Filter companies that have raised funding before this date. Example: 2019-12-30
industrystring- Filter companies belonging to an industry that matches the provided search expression. The industry attribute, found in a Company profile, describes the primary industry in which the company operates. The value of this attribute is an enumerator. See the full list of possible values for this attribute. We also infer a company's industry from various attributes. For example, the primary industry for https://www.linkedin.com/company/apple may be Computers and Electronics Manufacturing, but we may also classify it under Software Development. If you want to filter by the primary industry only, please refer to the primary_industry parameter. Example: technology || manufacturing
namestring- Filter companies with a name matching the provided search expression. Example: circle || amelex
next_tokenstring- The token for fetching the next page of results. Take the value of the next_token query parameter from the next_page URL of the previous response. When this parameter is provided, the search query is restored from the token. Filter parameters are not applied to the search, but they must still be syntactically valid, otherwise the request fails with a 400; only page_size, enrich_profiles and use_cache are honored. Example: eyJwYWdlIjogMn0=
page_sizestring- Tune the maximum results returned per API call. The default value of this parameter is 100. Accepted values for this parameter is an integer ranging from 1 to 100. When enrich_profiles=enrich, this parameter accepts value ranging from 1 to 10. Example: 10
primary_industrystring- Filter companies that has an industry that matches the provided search expression as the primary industry. The industry attribute, found in a Company profile, describes the primary industry in which the company operates. The value of this attribute is an enumerator. See the full list of possible values for this attribute. Example: software development
public_identifier_in_liststring- A list of public identifiers (the identifying portion of the company’s profile URL). The target company’s identifier must be a member of this list. Example: stripe,amazon
public_identifier_not_in_liststring- A list of public identifiers (the identifying portion of the company’s profile URL). The target company’s identifier must not be a member of this list. Example: stripe,amazon
regionstring- Filter companies with an office based in this region. A “region” in this context means “state,” “province,” or similar political division, depending on what country you’re querying. Example: Maryland OR "New York"
specialitiesstring- Filter companies that have a speciality that matches the provided search expression. Please note that we use the spelling specialities rather than specialties in this document. Example: innovative product development
typestring- Filter companies of the provided type. Possible values: * EDUCATIONAL: Educational Institution * GOVERNMENT_AGENCY: Government Agency * NON_PROFIT : Nonprofit * PARTNERSHIP : Partnership * PRIVATELY_HELD : Privately Held * PUBLIC_COMPANY : Public Company * SELF_EMPLOYED : Self-Employed * SELF_OWNED : Sole Proprietorship. Example: PRIVATELY_HELD
use_cachestring- 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. Example: if-present
enrichlayer_job_profile_getGet structured data of a job posting from its LinkedIn job URL.WriteGet Job Profile
Get structured data of a job posting from its LinkedIn job URL. Costs 2 credits per successful request. Returns title, company, location, employment type, seniority, description and apply URL. Use enrichlayer_job_profile_get for one posting. Use enrichlayer_company_jobs_search to list a company's jobs.
- Idempotent
Inputs
urlstringrequired- URL of the a Job Profile to target. The Job Search endpoint can be used to retrieve a job URL. Example: https://www.linkedin.com/jobs/view/3667167926/
enrichlayer_person_lookupFind a person's profile from their first name and company domain, optionally with last name, title and location.WriteLook Up Person
Find a person's profile from their first name and company domain, optionally with last name, title and location. Costs 2 credits; credits are charged even with no match unless similarity_checks is skip. Returns the best matching profile URL, a name similarity score and, when requested, the enriched profile. Use enrichlayer_person_lookup when you have a name and company but no URL. Use enrichlayer_person_search for criteria-based search.
- Idempotent
Inputs
company_domainstringrequired- Company name or domain. Example: gatesfoundation.org
first_namestringrequired- First name of the user. Example: Bill
enrich_profilestring- Enrich the result with a cached profile of the lookup result. The valid values are: * skip (default): do not enrich the results with cached profile data * enrich: enriches the result with cached profile data Calling this API endpoint with this parameter would add 1 credit. If you require fresh profile data, please chain this API call with the People Profile Endpoint with the use_cache=if-recent parameter. Example: skip
last_namestring- Last name of the user. Example: Gates
locationstring- The location of this user. Name of country, city or state. Example: Seattle
similarity_checksstring- Controls whether the API endpoint performs similarity comparisons between the input parameters and the results or simply returns the closest match. For instance, if you are searching for a person named "Jane Smith", and the closest result we have is "Tom Garcia", our similarity checks will discard the obviously incorrect result and return null instead of a false positive. Include similarity checks to eliminate false positives. However, be aware that this might yield fewer results as false positives are discarded. Credits will still be deducted even if we return null. You can choose to skip similarity checks, in which case no credits will be charged if we return null. This parameter accepts the following values: * include (default) - Perform similarity checks and discard false positives. Credits will be deducted even if we return null . * skip - Bypass similarity checks. No credits will be deducted if no results are returned. Example: include
titlestring- Title that user is holding at his/her current job. Example: Co-chair
enrichlayer_person_profile_getGet structured data of a person's professional profile from a profile URL (LinkedIn, Twitter/X or Facebook).WriteGet Person Profile
Get structured data of a person's professional profile from a profile URL (LinkedIn, Twitter/X or Facebook). Costs 1 credit per successful request, plus extra credits for each optional add-on requested. Returns name, headline, location, experience, education, skills and, when requested, extra fields, inferred salary and contact data. Use enrichlayer_person_profile_get when you have a profile URL. Use enrichlayer_person_lookup to find a profile from a name and company.
- Idempotent
Inputs
extrastring- Enriches the Person Profile with extra details from external sources. Extra details include gender, birth date, industry and interests. This parameter accepts the following values: - exclude (default value) - Does not provide extra data field. - include - Append extra data to the person profile object. Costs an extra 1 credit on top of the cost of the base endpoint (if data is available). Example: include
facebook_profile_idstring- Enriches the Person Profile with Facebook ID from external sources. This parameter accepts the following values: - exclude (default value) - Does not provide Facebook ID data field. - include - Append Facebook ID data to the person profile object. Costs an extra 1 credit on top of the cost of the base endpoint (if data is available). Example: include
facebook_profile_urlstring- The Facebook Profile URL from which you wish to extract person profile URL should be in the format of https://facebook.com/ Include only one of: profile_url, twitter_profile_url, or facebook_profile_url. Example: https://facebook.com/satyanadella/
fallback_to_cachestring- Tweaks the fallback behavior if an error arises from fetching a fresh profile. This parameter accepts the following values: * on-error (default value) - Fallback to reading the profile from cache if an error arises. * never - Do not ever read profile from cache. Example: on-error
github_profile_idstring- Enriches the Person Profile with GitHub ID from external sources. This parameter accepts the following values: - exclude (default value) - Does not provide GitHub ID data field. - include - Append GitHub ID data to the person profile object. Costs an extra 1 credit on top of the cost of the base endpoint (if data is available). Example: include
inferred_salarystring- Include inferred salary range from external sources. This parameter accepts the following values: - exclude (default value) - Does not provide inferred salary data field. - include - Append inferred salary range data to the person profile object. Costs an extra 1 credit on top of the cost of the base endpoint (if data is available). Example: include
live_fetchstring- Tweak the behavior of the API to fetch the fresh profile. This parameter accepts the following values: * force - Force the API to fetch the fresh profile. Costs an extra 9 credits on top of the cost of the base endpoint. * default (default value) - Do not force the API to fetch the fresh profile. Consider using use_cache instead. Example: default
profile_urlstring- The Profile URL from which you wish to extract. We support both raw UTF-8 input and URL-encoded input. For example, https://linkedin.com/in/rodríguez/ and https://linkedin.com/in/rodr%C3%ADguez/ are both valid. We don't support URLs with a hashed ID, e.g. https://www.linkedin.com/in/ACwAAExzrQ0Bjqu... Include only one of: profile_url, twitter_profile_url, or facebook_profile_url. Example: https://www.linkedin.com/in/williamhgates/
skillsstring- Include skills data from external sources. Skills are no longer available as part of public data, but we will show skills for historic profiles, or where skills are inferred or sourced by other means. Expect limited coverage. This parameter accepts the following values: - exclude (default value) - Does not provide skills data field. - include - Append skills data to the person profile object. No extra credit is charged for this parameter. Example: include
twitter_profile_idstring- Enriches the Person Profile with Twitter ID from external sources. This parameter accepts the following values: - exclude (default value) - Does not provide Twitter ID data field. - include - Append Twitter ID data to the person profile object. Costs an extra 1 credit on top of the cost of the base endpoint (if data is available). Example: include
twitter_profile_urlstring- The Twitter/X Profile URL from which you wish to extract person profile URL should be in the format of https://x.com/ Include only one of: profile_url, twitter_profile_url, or facebook_profile_url. Example: https://x.com/satyanadella/
use_cachestring- if-present - Fetches profile from cache regardless of age of profile. If profile is not available in cache, API will attempt to source profile externally. if-recent (Default) - API will make a best effort to return a fresh profile no older than 29 days. Costs an extra 1 credit on top of the cost of the base endpoint. Example: if-present
enrichlayer_person_searchSearch Enrich Layer's people dataset by location, name, education, current and past roles and companies, skills, industries and current company attributes, using boolean search expressions.WriteSearch People
Search Enrich Layer's people dataset by location, name, education, current and past roles and companies, skills, industries and current company attributes, using boolean search expressions. Costs 3 credits per profile returned (plus 1 per enriched profile). Returns a page of profile URLs (or enriched profiles), a next_page token and the total result count. Use enrichlayer_person_search to build prospect lists. Use enrichlayer_person_lookup to find one known person.
- Idempotent
Inputs
citystring- Filter people located in a city matching the provided search expression. Example: Seattle OR "Palo Alto"
countrystring- Filter people located in this country. This parameter accepts a case-insensitive Alpha-2 ISO3166 country code. Example: US
current_company_citystring- Filter people who are currently working at a company based in a city matching the provided search expression. Example: Seattle OR "Los Angeles"
current_company_countrystring- Filter people who are currently working at a company with an office based in this country. This parameter accepts a case-insensitive Alpha-2 ISO3166 country code. Example: US
current_company_descriptionstring- Filter people who are currently working at a company with a description matching the provided search expression. Example: medical device
current_company_domain_namestring- Filter people who are currently working at a company with a domain name matching the provided search expression. Example: pfizer.com
current_company_employee_count_categorystring- Filter people who are currently working at a company in this employee count category. This parameter will take precedence over current_company_employee_count_min and current_company_employee_count_max parameters. The valid values are: - custom (default): uses current_company_employee_count_min and current_company_employee_count_max parameters - startup: 1-10 employees - small: 11-50 employees - medium: 51-250 employees - large: 251-1000 employees - enterprise: 1001+ employees. Example: startup
current_company_employee_count_maxstring- Filter people who are currently working at a company with at most this many employees. Example: 1000
current_company_employee_count_minstring- Filter people who are currently working at a company with at least this many employees. Example: 1000
current_company_follower_count_maxstring- Filter people who are currently working at a company with a follower count less than this value. Example: 1000
current_company_follower_count_minstring- Filter people who are currently working at a company with a follower count of more than this value. Example: 100000
current_company_founded_after_yearstring- Filter people who are currently working at a company that was founded after this year. Example: 1999
current_company_founded_before_yearstring- Filter people who are currently working at a company that was founded before this year. Example: 1999
current_company_funding_amount_maxstring- Filter people who are currently working at a company that has raised at most this much (USD) funding amount. Example: 1000000
current_company_funding_amount_minstring- Filter people who are currently working at a company that has raised at least this much (USD) funding amount. Example: 1000000
current_company_funding_raised_afterstring- Filter people who are currently working at a company that has raised funding after this date. Example: 2019-12-30
current_company_funding_raised_beforestring- Filter people who are currently working at a company that has raised funding before this date. Example: 2019-12-30
current_company_industrystring- Filter people who are currently working at a company belonging to an industry that matches the provided search expression. The industry attribute, found in a Company profile, describes the primary industry in which the company operates. The value of this attribute is an enumerator. See the full list of possible values for this attribute. We also infer a company's industry from various attributes. For example, the primary industry for https://www.linkedin.com/company/apple may be Computers and Electronics Manufacturing, but we may also classify it under Software Development. If you want to filter by the primary industry only, please refer to the current_company_primary_industry parameter. Example: higher AND education
current_company_namestring- Filter people who are currently working at a company whose name matches the provided search expression. Example: Stripe OR Apple
current_company_primary_industrystring- Filter people who are currently working at a company belonging to an industry that matches the provided search expression. The industry attribute, found in a Company profile, describes the primary industry in which the company operates. The value of this attribute is an enumerator. See the full list of possible values for this attribute. Example: technology
current_company_profile_urlstring- Filter people who are currently working at a company represented by this Company Profile URL. Default value of this parameter is null. Example: https://www.linkedin.com/company/apple
current_company_regionstring- Filter people who are currently working at a company based in a region matching the provided search expression. Example: Texas
current_company_specialitiesstring- Filter people who are currently working at a company with a specialty matching the provided search expression. Please note that we use the spelling specialities rather than specialties in this document. Example: innovative product development
current_company_typestring- Filter people who are currently working at a company of the provided type. Possible values: * EDUCATIONAL: Educational Institution * GOVERNMENT_AGENCY: Government Agency * NON_PROFIT : Nonprofit * PARTNERSHIP : Partnership * PRIVATELY_HELD : Privately Held * PUBLIC_COMPANY : Public Company * SELF_EMPLOYED : Self-Employed * SELF_OWNED : Sole Proprietorship. Example: NON_PROFIT
current_job_descriptionstring- Filter people with current job descriptions matching the provided search expression. Example: education
current_role_afterstring- Filter people who started their current role after this date. You'll be looking for profiles that show a person's current job. However, keep in mind that some of these profiles may not be up-to-date, which means you might sometimes see a person's old job instead of their current job. This parameter takes a ISO8601 date. Default value of this parameter is null. Example: 2019-12-30
current_role_beforestring- Filter people who started their current role before this date. You'll be looking for profiles that show a person's current job. However, keep in mind that some of these profiles may not be up-to-date, which means you might sometimes see a person's old job instead of their current job. This parameter takes a ISO8601 date. Default value of this parameter is null. Example: 2019-12-30
current_role_titlestring- Filter people who are currently working as a role whose title matches the provided search expression. You'll be looking for profiles that show a person's current job. However, keep in mind that some of these profiles may not be up-to-date, which means you might sometimes see a person's old job instead of their current job. Example: CEO || Founder
education_degree_namestring- Filter people who earned a degree matching the provided search expression, based on education history. Example: MBA
education_field_of_studystring- Filter people with a field of study matching the provided search expression, based on education history. Example: computer science
education_school_namestring- Filter people who have attended a school whose name matches the provided search expression, based on education history. Example: "Harvard University"
education_school_profile_urlstring- Filter people who have attended a school with a specific profile URL, based on education history. Example: https://www.linkedin.com/school/mit/
enrich_profilesstring- Get the person's complete profile data rather than just the URLs to their profiles. Each request respond with a streaming response of profiles. The valid values are: * skip (default): lists person's profile url only * enrich: include person's profile data in the list Calling this API endpoint with this parameter would add 1 credit per enriched result returned. A profile returned without enrichment will not incur any per-profile charges. Example: skip
first_namestring- Filter people whose first names match the provided search expression. Example: Bill OR Mark
follower_count_maxstring- Filter people with a follower count less than this value. Example: 1000
follower_count_minstring- Filter people with a follower count of more than this value. Example: 1000
groupsstring- Filter people who are members of groups whose names match the provided search expression. Example: haskell
headlinestring- Filter people whose headline fields match the provided search expression. Example: founder
industriesstring- Person's inferred industry. May sometimes exist when current_company_industry does not, but current_company_industry should be preferred when it exists. Example: technology and software
interestsstring- Filter people whose interest fields match the provided search expression. Example: technology
languagesstring- Filter people who list a language matching the provided search expression. Example: Mandarin OR Chinese
last_namestring- Filter people whose last names match the provided search expression. Example: Gates or Zuckerberg
next_tokenstring- The token for fetching the next page of results. Take the value of the next_token query parameter from the next_page URL of the previous response. When this parameter is provided, the search query is restored from the token. Filter parameters are not applied to the search, but they must still be syntactically valid, otherwise the request fails with a 400; only page_size, enrich_profiles and use_cache are honored. Example: eyJwYWdlIjogMn0=
page_sizestring- Tune the maximum results returned per API call. The default value of this parameter is 100. Accepted values for this parameter is an integer ranging from 1 to 100. When enrich_profiles=enrich, this parameter accepts value ranging from 1 to 10. Example: 10
past_company_namestring- Filter people who have previously worked at a company whose name matches the provided search expression. Example: Stripe OR Apple
past_company_profile_urlstring- Filter people who have in the past worked at the company represented by this Company Profile URL. This parameter takes a Company Profile URL. Default value of this parameter is null. Example: https://www.linkedin.com/company/apple
past_job_descriptionstring- Filter people with past job descriptions matching the provided search expression. Example: education
past_role_titlestring- Filter people who have in the past worked as a role whose title matches the provided search expression. Example: founder
public_identifier_in_liststring- A list of public identifiers (the identifying portion of the person’s profile URL). The target person’s identifier must be a member of this list. Example: williamhgates,satyanadella
public_identifier_not_in_liststring- A list of public identifiers (the identifying portion of the person’s profile URL). The target person’s identifier must not be a member of this list. Example: mark-zuckerberg-618bba58,jeff-bezos-879307323
regionstring- Filter people located in a region matching the provided search expression. A “region” in this context means “state,” “province,” or similar political division, depending on what country you’re querying. Example: California or Washington
skillsstring- Filter people whose skill fields match the provided search expression. Example: accounting
skills_all_in_liststring- Filter people whose skill fields match all the skills in the list. This parameter accepts a comma-separated list of skills and returns profiles that include all the skills in the list. This parameter can't be combined with the skills parameter. Please only use one of them. Example: rust,mongodb
summarystring- Filter people whose summary fields match the provided search expression. Example: founder
use_cachestring- 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. Example: if-present
enrichlayer_reverse_email_lookupFind the professional profile behind an email address (work or personal).WriteReverse Email Lookup
Find the professional profile behind an email address (work or personal). Costs 3 credits; charged even with no match unless lookup_depth is superficial. Returns matching profile URLs and, when requested, the enriched profile. Use enrichlayer_reverse_email_lookup to identify who sent an email. Use enrichlayer_person_lookup when you have a name instead.
- Idempotent
Inputs
emailstringrequired- Email address of the user you want to look up. Example: johndoe@enrichlayer.com
enrich_profilestring- Enrich the result with a cached profile (if any). Valid values are: * skip (default): do not enrich the results with cached profile data. * enrich: enriches the result with cached profile data. Calling this API endpoint with this parameter would add 1 additional credit. If you require fresh profile data, please chain this API call with the linkedin_profile_url result with the Person Profile Endpoint with the use_cache=if-recent parameter. Example: skip
lookup_depthstring- This parameter describes the depth options for our API lookup function. This endpoint can execute either a superficial or a deep lookup. A superficial lookup involves comparing the provided email with entries in our database. This approach tends to yield fewer results and is typically less effective for work-related email addresses. However, it does not consume any credits if no results are returned. On the other hand, a deep lookup extends beyond our database to utilize advanced heuristics and identify the individual associated with a given email. This method is particularly recommended for work emails. Please note the following valid values for the depth of the lookup: * superficial: No credits are consumed if no results are found. * deep (default): Credits are used regardless of whether any results are returned. Example: deep
enrichlayer_role_lookupFind the person who best matches a role (for example CTO) at a company.WriteLook Up Role at Company
Find the person who best matches a role (for example CTO) at a company. Costs 3 credits on any 200 response, even without a match. Returns one profile URL and, when requested, the enriched profile. Use enrichlayer_role_lookup for a single decision maker. Use enrichlayer_company_employee_search for every match.
- Idempotent
Inputs
company_namestringrequired- Name of the company that you are searching for. Example: enrichlayer
rolestringrequired- Role of the profile that you are looking up. Example: ceo
enrich_profilestring- Enrich the result with a cached profile of the lookup result. The valid values are: * skip (default): do not enrich the results with cached profile data * enrich: enriches the result with cached profile data Calling this API endpoint with this parameter would add 1 credit. If you require fresh profile data, please chain this API call with the Person Profile Endpoint with the use_cache=if-recent parameter. Example: skip
enrichlayer_school_profile_getGet structured data of a school profile from its LinkedIn school URL.WriteGet School Profile
Get structured data of a school profile from its LinkedIn school URL. Costs 1 credit per successful request. Returns name, description, website, location, size and other school details. Use enrichlayer_school_profile_get for universities and schools. Use enrichlayer_company_profile_get for companies.
- Idempotent
Inputs
urlstringrequired- URL of the School Profile to crawl. Example: https://www.linkedin.com/school/national-university-of-singapore/
live_fetchstring- Tweak the behavior of the API to fetch the fresh profile. This parameter accepts the following values: * force - Force the API to fetch the fresh profile. Costs an extra 9 credits on top of the cost of the base endpoint. * default (default value) - Do not force the API to fetch the fresh profile. Consider using use_cache instead. Example: default
use_cachestring- if-present The default behavior.Fetches profile from cache regardless of age of profile. If profile is not available in cache, API will attempt to source profile externally. if-recent API will make a best effort to return a fresh profile no older than 29 days.Costs an extra 1 credit on top of the cost of the base endpoint. Example: if-present
enrichlayer_work_email_lookupFind the verified work email address of a person from their profile URL.WriteLook Up Work Email
Find the verified work email address of a person from their profile URL. Costs 3 credits, refunded when no email is found; results can take time and may be sent to callback_url. Returns the work email and its status, or a callback when the lookup runs asynchronously. Use enrichlayer_work_email_lookup for B2B outreach. Use enrichlayer_disposable_email_check to screen an address you already have.
- Idempotent
Inputs
profile_urlstringrequired- Profile URL of the person you want to extract work email address from. Example: https://www.linkedin.com/in/williamhgates/
callback_urlstring- Webhook to notify your application when the request has finished processing. Example: https://webhook.site/29e12f17-d5a2-400a-9d08-42ee9d83600a
No tools match.