LeadIQ | Documentation

The LeadIQ component is an application component that allows users to search for prospects and enrich your leads. It can carry out the following tasks:

Find Prospects

#Release Stage

Alpha

#Configuration

The component definition and tasks are defined in the definition.json and tasks.json files respectively.

#Setup

In order to communicate with LeadIQ, the following connection details need to be provided. You may specify them directly in a pipeline recipe as key-value pairs within the component's setup block, or you can create a Connection from the Integration Settings page and reference the whole setup as setup: ${connection.<my-connection-id>}.

Field	Field ID	Type	Note
API Key (required)	`api-key`	string	Fill in your LeadIQ Secret Base64 API key, you can find it in API Key.

#Supported Tasks

#Find Prospects

Find prospects' contact information based on the company name you provide. And, it will filter out the prospects who are not relevant to your search.

Input	ID	Type	Description
Task ID (required)	`task`	string	`TASK_FIND_PROSPECTS`
Company (required)	`company`	object	Provide the company information for which you want to find prospects.
Limit (required)	`limit`	integer	Provide the number of prospects you want to find. If you don't provide any value, it will return 10 prospects. The maximum limit is 60. The minimum limit is 1.
Filter By	`filter-by`	object	Provide the information about the prospects you want to filter. You can filter the prospects based on job title, name, seniority, and function. When it matches, the prospect will be included in the output. If you don't provide any value, it will return all the prospects.

Input Objects in Find Prospects

Company

Provide the company information for which you want to find prospects.

Field	Field ID	Type	Note
Cities	`cities`	array	Provide the cities of the company you want to find prospects. If you don't provide any value, it will return all the prospects.
Countries	`countries`	array	Provide the countries of the company you want to find prospects. If you don't provide any value, it will return all the prospects.
Descriptions	`descriptions`	array	Provide the descriptions of the company you want to find prospects. In LeadIQ, it will return the similar companies based on the descriptions.
Industries	`industries`	array	Provide the industries of the company you want to find prospects. If you don't provide any value, it will return all the prospects.
Names	`names`	array	Provide the company names for which you want to find prospects.
Revenue Size	`revenue-size`	object	Provide the min or max revenue size of the company you want to find prospects. If you don't provide any value, it will return all the prospects. If you set the company names, the revenue size will be ignored.
States	`states`	array	Provide the states of the company you want to find prospects. If you don't provide any value, it will return all the prospects.
Technologies	`technologies`	array	Provide the technologies used by the company you want to find prospects. If you don't provide any value, it will return all the prospects.

Revenue Size

Provide the min or max revenue size of the company you want to find prospects. If you don't provide any value, it will return all the prospects. If you set the company names, the revenue size will be ignored.

Field	Field ID	Type	Note
Max	`max`	integer	Provide the maximum revenue size of the company you want to find prospects.
Min	`min`	integer	Provide the minimum revenue size of the company you want to find prospects.

Filter By

Provide the information about the prospects you want to filter. You can filter the prospects based on job title, name, seniority, and function. When it matches, the prospect will be included in the output. If you don't provide any value, it will return all the prospects.

Field	Field ID	Type	Note
Function	`function`	string	Provide the function of the prospects you want to filter with regular expression.
Job Title	`job-title`	string	Provide the job title of the prospects you want to filter with regular expression.
Seniorities	`seniorities`	array	Provide the seniorities of the prospects you want to filter. Enum values `Executive` `Director` `SeniorIndividualContributor` `VP` `Manager` `Other`

Output	ID	Type	Description
Prospects (optional)	`prospects`	array[object]	The list of prospects' contact information based on the company information you provide.

Output Objects in Find Prospects

Prospects

Field	Field ID	Type	Note
Company Address	`company-address`	string	The address of the company from LeadIQ. It combines the city, state, and country.
Company Description	`company-description`	string	The description of the company from LeadIQ.
Company Industry	`company-industry`	string	The industry of the company from LeadIQ.
Company Name	`company-name`	string	The company name of the prospect.
Company Technologies	`company-technologies`	array	The technologies used by the company from LeadIQ.
Company Technology Categories	`company-technology-categories`	array	The technology categories of the company from LeadIQ.
Email	`email`	string	The email address of the prospect.
Job Title	`job-title`	string	The job title of the prospect.
LinkedIn URL	`linkedin-url`	string	The LinkedIn URL of the prospect.
Name	`name`	string	The name of the prospect.
Revenue Size	`revenue-size`	object	The revenue size of the company from LeadIQ.
Seniority	`seniority`	string	The seniority of the prospect.

Revenue Size

Field	Field ID	Type	Note
Description	`description`	string	The description of the revenue size of the company from LeadIQ.
Max	`max`	integer	The maximum revenue size of the company from LeadIQ.
Min	`min`	integer	The minimum revenue size of the company from LeadIQ.

#Regex Match Sample

Match Sales or Founder with case-insensitive

(?i)\b(sales|founder)\b
Match titles containing "Manager", "Director", or "VP" (case-insensitive)

(?i)\b(manager|director|vp)\b
Match titles starting with "Chief" (e.g., "Chief Executive Officer", "Chief Marketing Officer")

(?i)\bchief\s\w+\b
Match "Engineer", "Developer", or "Programmer" (case-insensitive)

(?i)\b(engineer|developer|programmer)\b

#Example Recipes

version: v1beta
variable:
  city:
    title: City
    format: string
    default: "London"
  country:
    title: Country
    format: string
    default: "United Kingdom"
  industry:
    title: Industry
    format: string
    default: "Software Development"
  description:
    title: Description
    format: string
    default: "AI"
  technology:
    title: Technology
    format: string
    default: "HTTP"
component:
  prospects:
    type: leadiq
    task: TASK_FIND_PROSPECTS
    input:
      company:
        names:
        revenue-size:
          min: 10000000
          max:
        countries:
          - ${variable.country}
        states:
        cities:
          - ${variable.city}
        industries:
          - ${variable.industry}
        descriptions:
          - ${variable.description}
        technologies:
          - ${variable.technology}
      limit: 2
      filter-by:
        job-title: (?i)\b(sales|founder)\b
        seniorities:
          - Executive
          - Director
        function:
    condition:
output:
  result:
    title: Result
    value: ${prospects.output}