Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to CompanyEnrich

Scalekit connector
Open markdown

The CompanyEnrich connector lets your AI agent act in each user's CompanyEnrich account. Each user connects their own CompanyEnrich access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 31 tools.

Tools
31
What they doRead · write · destructive
31 · 0 · 031 read0 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 CompanyEnrich connection

    In AgentKit > Connections, create a CompanyEnrich 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 = 'companyenrich'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize CompanyEnrich:', 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: 'companyenrich_get_account',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their CompanyEnrich 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
  • companyenrich_autocomplete_companiesSuggest companies whose domain matches partial text.Read-only

    Autocomplete Companies

    Suggest companies whose domain matches partial text. Free. Returns up to 10 companies, each with domain, name and logoUrl. Use this to turn a partial or misspelt company name into a domain before enriching it. Use companyenrich_search_companies for filtered search.

    Inputs

    querystringrequired
    Partial company domain or name to complete. Example: strip
  • companyenrich_autocomplete_keywordsSuggest business keywords that match partial text.Read-only

    Autocomplete Keywords

    Suggest business keywords that match partial text. Free. Returns an array of matching business keywords as strings. Use this to get exact values for the keywords filter of companyenrich_search_companies.

    Inputs

    querystringrequired
    Partial text to complete. Example: fintech
  • companyenrich_autocomplete_positionsSuggest job titles that match partial text.Read-only

    Autocomplete Positions

    Suggest job titles that match partial text. Free. Returns an array of matching job titles as strings. Use this to get exact values for the position_query filter of companyenrich_search_people.

    Inputs

    querystringrequired
    Partial text to complete. Example: head of sa
  • companyenrich_autocomplete_technologiesSuggest technology names that match partial text.Read-only

    Autocomplete Technologies

    Suggest technology names that match partial text. Free. Returns an array of matching technology names as strings. Use this to get exact values for the technologies filter of companyenrich_search_companies.

    Inputs

    querystringrequired
    Partial text to complete. Example: salesfor
  • companyenrich_batch_enrich_companiesEnrich up to 50 companies from their domains in one call.Read-only

    Batch Enrich Companies

    Enrich up to 50 companies from their domains in one call. Costs 1 credit per company enriched. Returns an array of company profiles, in the same shape as companyenrich_enrich_company_by_domain; domains that cannot be enriched are left out. Use this for a list of domains. Use companyenrich_enrich_company_by_domain for a single domain.

    Inputs

    domainsarrayrequired
    Company domains to enrich, 1 to 50. Example: ["stripe.com", "notion.so"]
    expandarray
    Extra response fields to include. The only value is workforce, which adds a workforce object (observed employee count, employee range and headcount by department) to each company and costs 5 extra credits per company. Omit to skip it. Example: ["workforce"]
  • companyenrich_count_companiesCount the companies that match a set of search filters, without returning them.Read-only

    Count Companies

    Count the companies that match a set of search filters, without returning them. Free. Returns the number of matching companies as a plain number. Use this to check or narrow filters before companyenrich_search_companies, which charges per result.

    Inputs

    categoryarray
    Business model categories to include: b2b, b2c, b2g, e-commerce, media, service-provider, mobile, saas. Combine several with category_operator. Example: ["b2b", "saas"]
    category_operatorstring
    How multiple categories combine: And (company must match all, the default) or Or (any).one of AndOr
    citiesarray
    Numeric city IDs to filter by, from companyenrich_search_cities. Example: [111182]
    countriesarray
    Two-letter ISO country codes of the company's headquarters. Example: ["US", "GB"]
    employeesarray
    Employee count ranges from CompanyEnrich's own data: 1-10, 11-50, 51-200, 201-500, 501-1K, 1K-5K, 5K-10K, over-10K. Example: ["51-200", "201-500"]
    excludeobject
    Companies to leave out. A company matching any of these is excluded. Accepts the same filters as the include side, in the API's camelCase form (domains, countries, regions, states, cities, type, category, employees, reportedEmployees, revenue, naicsCode, keywords, technologies, fundingRounds). Example: {"domains": ["stripe.com"], "countries": ["CN"]}
    founded_yearobject
    Range of founding years, inclusive, as an object with min and/or max. Example: {"min": 2015, "max": 2022}
    funding_amountobject
    Range of total funding raised in USD, inclusive, as an object with min and/or max. Example: {"min": 1000000, "max": 50000000}
    funding_roundsarray
    Funding round types the company has raised: seed, debt_financing, angel, venture, series_a, series_b, series_c, series_d, series_e, series_f, series_g, series_h, other. Example: ["series_a", "series_b"]
    funding_yearobject
    Range of years of the latest funding round, inclusive, as an object with min and/or max. Example: {"min": 2015, "max": 2022}
    keywordsarray
    Keywords describing what the company does. companyenrich_autocomplete_keywords suggests valid keywords. Example: ["payments", "fintech"]
    keywords_operatorstring
    How multiple keywords combine: And (all, the default) or Or (any).one of AndOr
    listsarray
    Only return companies saved in these CompanyEnrich company lists, by list ID (UUID). companyenrich_list_company_lists returns the IDs. Example: ["3fa85f64-5717-4562-b3fc-2c963f66afa6"]
    naics_codesarray
    NAICS industry codes, 2 to 6 digits. A shorter code includes every 6-digit code under it. companyenrich_list_industries maps industries to codes. Example: [5112, 541511]
    querystring
    Text matched against company names and domains, up to 250 characters. Example: stripe
    regionsarray
    Region IDs to filter by, from companyenrich_list_regions. Example: ["europe"]
    reported_employeesarray
    Employee count ranges as reported by external data providers, same values as employees. Example: ["1K-5K"]
    requirearray
    Data the company record must have: linkedin, twitter, facebook, instagram, angellist, crunchbase, youtube, country, city, state, revenue, foundedYear, anyFunding. Example: ["linkedin", "revenue"]
    revenuearray
    Annual revenue ranges in USD: under-1m, 1m-10m, 10m-50m, 50m-100m, 100m-200m, 200m-1b, over-1b. Example: ["10m-50m"]
    semantic_querystring
    Natural-language description of the companies to find, up to 500 characters. Ranked by meaning rather than exact words. Example: developer tools for payments infrastructure
    semantic_weightnumber
    How much the semantic query counts against the other ranking factors, from 0 to 1. Defaults to 0.7; higher values favour semantic similarity. Only used with semantic_query. Example: 0.7
    statesarray
    Numeric state IDs to filter by, from companyenrich_search_states. Example: [1416]
    technologiesarray
    Technologies the company uses. companyenrich_autocomplete_technologies suggests valid names. Example: ["Salesforce", "HubSpot"]
    technologies_operatorstring
    How multiple technologies combine: And (all, the default) or Or (any).one of AndOr
    typearray
    Company ownership types to include: private, public, self-employed, self-owned, partnership, nonprofit, educational, government. Example: ["private", "public"]
    workforce_growthobject
    Filter on headcount growth over a period. period is m6 (6 months), y1 or y2; department is overall (the default) or one of c_suite, product_management, engineering_technical, design, education, finance, human_resources, information_technology, legal, marketing, medical_health, operations, sales, consulting; minPercent and maxPercent bound the change in percent (15 means 15% growth, -10 means 10% decline). Example: {"period": "y1", "department": "engineering_technical", "minPercent": 20}
    workforce_sizearray
    Filter on absolute headcount, one entry per department. Each entry has a department (overall by default, or a department such as engineering_technical or sales) and a min and/or max headcount. Example: [{"department": "engineering_technical", "min": 50}]
  • companyenrich_count_similar_companiesCount the lookalike companies for 1 to 10 seed domains and optional filters, without returning them.Read-only

    Count Similar Companies

    Count the lookalike companies for 1 to 10 seed domains and optional filters, without returning them. Free. Returns the number of matching companies as a plain number. Use this before companyenrich_find_similar_companies, which charges 5 credits per result.

    Inputs

    domainsarrayrequired
    Domains of 1 to 10 seed companies to find lookalikes for. Example: ["stripe.com"]
    categoryarray
    Business model categories to include: b2b, b2c, b2g, e-commerce, media, service-provider, mobile, saas. Combine several with category_operator. Example: ["b2b", "saas"]
    category_operatorstring
    How multiple categories combine: And (company must match all, the default) or Or (any).one of AndOr
    citiesarray
    Numeric city IDs to filter by, from companyenrich_search_cities. Example: [111182]
    countriesarray
    Two-letter ISO country codes of the company's headquarters. Example: ["US", "GB"]
    employeesarray
    Employee count ranges from CompanyEnrich's own data: 1-10, 11-50, 51-200, 201-500, 501-1K, 1K-5K, 5K-10K, over-10K. Example: ["51-200", "201-500"]
    excludeobject
    Companies to leave out. A company matching any of these is excluded. Accepts the same filters as the include side, in the API's camelCase form (domains, countries, regions, states, cities, type, category, employees, reportedEmployees, revenue, naicsCode, keywords, technologies, fundingRounds). Example: {"domains": ["stripe.com"], "countries": ["CN"]}
    founded_yearobject
    Range of founding years, inclusive, as an object with min and/or max. Example: {"min": 2015, "max": 2022}
    funding_amountobject
    Range of total funding raised in USD, inclusive, as an object with min and/or max. Example: {"min": 1000000, "max": 50000000}
    funding_roundsarray
    Funding round types the company has raised: seed, debt_financing, angel, venture, series_a, series_b, series_c, series_d, series_e, series_f, series_g, series_h, other. Example: ["series_a", "series_b"]
    funding_yearobject
    Range of years of the latest funding round, inclusive, as an object with min and/or max. Example: {"min": 2015, "max": 2022}
    keywordsarray
    Keywords describing what the company does. companyenrich_autocomplete_keywords suggests valid keywords. Example: ["payments", "fintech"]
    keywords_operatorstring
    How multiple keywords combine: And (all, the default) or Or (any).one of AndOr
    min_scorenumber
    Minimum similarity score a result must reach, from 0 to 1. Omit to use the default cutoff. Example: 0.6
    naics_codesarray
    NAICS industry codes, 2 to 6 digits. A shorter code includes every 6-digit code under it. companyenrich_list_industries maps industries to codes. Example: [5112, 541511]
    querystring
    Text matched against company names and domains, up to 250 characters. Example: stripe
    regionsarray
    Region IDs to filter by, from companyenrich_list_regions. Example: ["europe"]
    reported_employeesarray
    Employee count ranges as reported by external data providers, same values as employees. Example: ["1K-5K"]
    requirearray
    Data the company record must have: linkedin, twitter, facebook, instagram, angellist, crunchbase, youtube, country, city, state, revenue, foundedYear, anyFunding. Example: ["linkedin", "revenue"]
    revenuearray
    Annual revenue ranges in USD: under-1m, 1m-10m, 10m-50m, 50m-100m, 100m-200m, 200m-1b, over-1b. Example: ["10m-50m"]
    similarity_weightnumber
    From -1 to 1, default 0. Higher values favour the most similar companies; lower values favour larger, more established companies. Example: 0.5
    statesarray
    Numeric state IDs to filter by, from companyenrich_search_states. Example: [1416]
    technologiesarray
    Technologies the company uses. companyenrich_autocomplete_technologies suggests valid names. Example: ["Salesforce", "HubSpot"]
    technologies_operatorstring
    How multiple technologies combine: And (all, the default) or Or (any).one of AndOr
    typearray
    Company ownership types to include: private, public, self-employed, self-owned, partnership, nonprofit, educational, government. Example: ["private", "public"]
    wait_for_enrichmentboolean
    Whether to wait when a seed domain is not in CompanyEnrich's database yet. Defaults to true. Set false to return 404 straight away when any seed company is missing; the missing domains are then enriched in the background so a later retry succeeds.
    workforce_growthobject
    Filter on headcount growth over a period. period is m6 (6 months), y1 or y2; department is overall (the default) or one of c_suite, product_management, engineering_technical, design, education, finance, human_resources, information_technology, legal, marketing, medical_health, operations, sales, consulting; minPercent and maxPercent bound the change in percent (15 means 15% growth, -10 means 10% decline). Example: {"period": "y1", "department": "engineering_technical", "minPercent": 20}
    workforce_sizearray
    Filter on absolute headcount, one entry per department. Each entry has a department (overall by default, or a department such as engineering_technical or sales) and a min and/or max headcount. Example: [{"department": "engineering_technical", "min": 50}]
  • companyenrich_enrich_company_by_domainEnrich one company from its website domain.Read-only

    Enrich Company by Domain

    Enrich one company from its website domain. Costs 1 credit. Returns the company profile: id, name, website, type, industry and industries, categories, employee and revenue ranges, description, keywords, technologies, founded year, NAICS codes, location, funding and stock details, social profile URLs and logo URL. Use this when you know the domain; it is the most reliable lookup. Use companyenrich_enrich_company_by_properties when you only have a name or social profile URL, companyenrich_batch_enrich_companies for up to 50 domains at once, and companyenrich_get_company for a CompanyEnrich ID.

    Inputs

    domainstringrequired
    Company website domain, without protocol or path. Example: stripe.com
    expandarray
    Extra response fields to include. The only value is workforce, which adds a workforce object (observed employee count, employee range and headcount by department) to each company and costs 5 extra credits per company. Omit to skip it. Example: ["workforce"]
    wait_for_enrichmentboolean
    Whether to wait for on-demand enrichment when the company is not in CompanyEnrich's database yet. Defaults to true. Set false to return stored data immediately; an unknown company then returns 404 without using credits and is enriched in the background so a later call can find it.