Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Enrich Layer

Scalekit connector
Open markdown

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

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. 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>
  3. Create the Enrich Layer connection

    In AgentKit > Connections, create an Enrich Layer connection. The name you give it is the connection_name your code passes. See Configure connections.

  4. 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.actions
    const connector = 'enrichlayer'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { 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 call
    const result = await actions.executeTool({
    connector,
    identifier,
    toolName: 'enrichlayer_credit_balance_get',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each 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 to execute_tool
Try in PlaygroundRequest a tool
  • enrichlayer_company_id_lookupGet a company's vanity (public) ID from its numeric LinkedIn ID.Read-only

    Look 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-only

    Get 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-only

    Get 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-only

    Check 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-only

    Get 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.Write

    Get 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_employees_listList people who work or worked at a company, optionally by country, role and employment status.Write

    List 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