Skip to main content
Retrieve lead contact details
Wrk Product avatar
Written by Wrk Product
Updated over a week ago

Searches and retrieves personal, business, and contact information of people matching the search criteria provided.

This Wrk Action divides. For more information on divides please visit our article explaining Divides.

Common use cases

  • Lead Enrichment

Application

  • People Insight

Inputs (what you have)

Name

Description

Data Type

Required?

Example

Maximum number of results

Integer

Required

Full name

Contact full name

Text(Long)

Optional

First name

Contact first name

Text(Short)

Optional

Last name

Contact last name

Text(Short)

Optional

Email

Work email address for the contact in example@example.com format

Email

Optional

Phone

List of person phones or mobile numbers. Press the “Enter” key after each phone number is added

List of Phone

Optional

Job title(s)

Contact title at current place of employment. Press “Enter” to input multiple job titles

List of Text(Short)

Optional

Exclude job title(s)

Exclude list of job titles. Press the “Enter” key after each job title is added

List of Text(Short)

Optional

Management level

Contact management level at current place of employment. Choose from: Board Member, C Level Exec, VP Level Exec, Director, Manager, Non Manager. Press the “Enter” key after each level is added

List of Text

Optional

Department

Contact department at current place of employment. Choose from: C-Suite, Finance, Human Resources, Sales, Operations, Information Technology, Engineering & Technical, Marketing, Legal, Medical & Health, Other. Press the “Enter” key after each department is added

List of text

Optional

Job function

Contact job function at their current place of employment. Press the “Enter” key after each job function is added

List of text

Optional

Location search type

Location criteria for search

Pre-defined choice list

Optional

Country

Country for the primary address. Impacted by Location search type

Text(short)

Optional

Canada

State

State or province. You can use free text, or two-letter common abbreviation for a U.S. state. Impacted by Location search type

Text(Short)

Optional

new hampshire or nh

Contact validated after

The date after which the contact's profile was last validated

Date

Optional

Company website

URL to the company website in http://www.example.com format

URL

Optional

Required fields

Specify a list of required fields for each record returned. Can include email, phone, personalEmail, and mobilePhone

List of text

Optional

Phone, Email

Contact accuracy minimum

Minimum accuracy score for search results. This score indicates the likelihood that a contact is reachable and still employed by the company listed. Minimum score is 70 and maximum is 99.

Integer

Optional

Additional filters

Add extra filters in JSON format to further customize your contact search

Text(Long)

Optional

{“companyType”:”private”}

Note 1: the value of inputs can either be a set value in the configuration of the Wrk Action within the Wrkflow, or a variable from the Data library section. These variables in the Data library section are the outputs of previous Wrk Actions in the Wrkflow.

Note 2: Additional filters can be configured to add new filters that are not included in the pre-defined inputs. This must be done in JSON format following this pattern:

{

"filtername1" : "##{{filter value 1}}",

"filtername2" : "##{{filter value 2}}",

...}

List of possible filters:

Filtername

Format

Description

supplementalEmail

Text

Supplemental email address for the contact in example@example.com format

hashedEmail

Text

Hashed email value for the contact. Allows searching via an email address with the extra security of not exposing the email. Supported hash algorithms are: MD5, SHA1, SHA256 and SHA512.

middleInitial

Text

Contact middle initial

excludeManagementLevel

Text

Exclude contact based on management level.

boardMember

Text

Exclude or include board members from search results. By default, the API includes board members in results

excludePartialProfiles

True or False

Contacts who do not have an active company associated with them are considered partial profiles. Exclude contacts with a partial profile from search results.

executivesOnly

True or False

Return only executives

contactAccuracyScoreMax

Text

Maximum accuracy score for search results. This score indicates the likelihood that a contact is reachable and still employed by the company listed. Minimum score is 70 and maximum is 99.

lastUpdatedDateAfter

String

The date after which the contact's profile was last updated in YYYY-MM-DD format

validDateAfter

String

The date after which the contact's profile was last validated in YYYY-MM-DD format

lastUpdatedInMonths

Integer

Number of months within which the contact's profile was last updated. For example, if lastUpdatedinMonths is 12 only contacts that were updated in the last 12 months will be returned.

hasBeenNotified

String

Contacts who have been notified of inclusion in ZoomInfo's database. Values are exclude, include, and only.

companyPastOrPresent

String

Returns companies based on a contact's work history. Values are present (default), past, and pastAndPresent.

school

String

Contact educational institution

degree

String

Contact education degree

locationCompanyId

Array

Searches by contact's location IDs. Use the Location Enrich endpoint to obtain a list of location IDs for a company.

companyId

String

ZoomInfo unique identifier for the company. Will accept a comma-separated list.

companyName

String

Company name. Can use OR and NOT operators to include or exclude companies by name. For example, "Vodaphone OR Comcast NOT Verizon"

companyWebsite

String

URL to the company website in http://www.example.com format

companyTicker

Array

Company stock ticker symbol

companyDescription

String

Text description unique to the company you want to use as search criteria

parentId

String

ZoomInfo Company ID for parent company

ultimateParentId

String

ZoomInfo Company ID for ultimate parent company

companyType

String

Company type (private, public, and so on). See the Company Type lookup endpoint for values.

address

String

Company address

street

String

Company street

state

String

Company state (U.S.) or province (Canada). You can use free text state or province names (e.g., "new hampshire"), the two-letter common abbreviation for a U.S. state (e.g., "nh"), or values provided in the State lookup endpoint.

zipCode

String

Zip Code of the company's primary address

country

String

Country for the company's primary address. You can use free text or see the Country lookup endpoint for values.

continent

String

Continent for the company's primary address. See the Continent lookup endpoint for values.

zipCodeRadiusMiles

String

Used in conjunction with zipCode, designates a geographical radius (in miles) from the zipCode provided.

hashTagString

String

Hash tags for a company. Can include a comma-separated list.

techAttributeTagList

String

Specify technology product tags. See the Tech - Product lookup endpoint for values. This string uses a numerical dot notation format similar to an IP address. The notation denotes the hierarchical structure: parent-category.category.vendor. For example, 333.202.28. You can use wildcards in the notation (e.g., 333.202.\\\*, \\\*.202.\\\*, and so on).

subUnitTypes

String

Company sub types (e.g., division, subsidiary and so on). See the Sub Unit Type lookup endpoint for values.

primaryIndustriesOnly

Boolean

Used in conjunction with the industryCodes input parameter. When set to true, any result returned must have one of the specified industries as a primary industry. If no industries are specified, then this parameter will be ignored. Default is false.

industryCodes

String

Top-level industry that the contact works in. A contact can have multiple top level industries. Tags are based on the contact's current company. Can include a comma-separated list. See the Industry Codes lookup endpoint for values.

industryKeywords

String

Industry keywords associated with a company. Can include a comma-separated list.

sicCodes

String

The Standard Industrial Classification is a system for classifying industries by a four-digit code. See the SIC Codes lookup endpoint for values.

naicsCodes

String

The North American Industry Classification System (NAICS) is the standard used by Federal statistical agencies in classifying business establishments for the purpose of collecting, analyzing, and publishing statistical data related to the U.S. business economy. See the NAICS Codes lookup endpoint for values.

revenueMin

Integer

Minimum annual revenue for a company in U.S. dollars. Use with revenueMax to set a range. Alternatively, you can use the revenue parameter to search for pre-defined ranges.

revenueMax

Integer

Maximum annual revenue for a company in U.S. dollars. Use with revenueMin to set a range. Alternatively, you can use the revenue parameter to search for pre-defined ranges.

revenue

String

Annual revenue range in U.S. dollars. Accepts a comma-separated list of values. See the Revenue Range lookup endpoint for values. Alternatively, to get more granular ranges, you can use the revenueMin and revenueMax parameters.

employeeRangeMin

String

Minimum employee count for a company. Use with employeeRangeMax to set a range. Alternatively, you can use the employeeCount parameter to search for pre-defined ranges.

employeeRangeMax

String

Maximum employee count for a company. Use with employeeRangeMin to set a range. Alternatively, you can use the employeeCount parameter to search for pre-defined ranges.

employeeCount

String

Employee count range. Accepts a comma-separated list of values. See the Employee Count lookup endpoint for values. Alternatively, to get more granular ranges, you can use the employeeRangeMin and employeeRangeMax parameters.

companyRanking

String

Company ranking list (e.g., Fortune 500 and so on). See the Company Ranking lookup endpoint for values.

metroRegion

String

Company metro area. Accepts a comma-separated list of U.S. and Canada metro areas. See the Metro Area lookup endpoint for values.

locationSearchType

String

Location criteria for search. Values are PersonOrHQ, PersonAndHQ, Person, HQ, PersonThenHQ.

fundingAmountMin

Integer

Minimum funding amount in thousands (e.g., 1 = 1000, 500 = 500,000). If fundingAmountMin is used without fundingAmountMax, the result will be the amount specified or greater.

fundingAmountMax

Integer

Maximum funding amount in thousands (e.g., 1 = 1000, 500 = 500,000). If fundingAmountMax is used without fundingAmountMin, the result will be the amount specified or less.

fundingStartDate

String

Start date of the funding in YYYY-MM-DD format. If fundingStartDate and fundingEndDate are both specified, they will be used as a range. Start date after end date returns an error. If start date and end date are the same, will return results for exact date.

fundingEndDate

String

End date of the funding in YYYY-MM-DD format. If fundingStartDate and fundingEndDate are both specified, they will be used as a range. Start date after end date returns an error. If start date and end date are the same, will return results for exact date.

excludedRegions

String

Exclude a company metro area. Accepts a comma-separated list of U.S. and Canada metro areas. See the Metro Area lookup endpoint for values.

zoominfoContactsMin

String

Minimum number of ZoomInfo contacts associated with company

zoominfoContactsMax

String

Maximum number of ZoomInfo contacts associated with company

companyStructureIncludedSubUnitTypes

String

Company hierarchical structure

oneYearEmployeeGrowthRateMin

String

Minimum one year employee growth rate for a company. Use with oneYearEmployeeGrowthRateMax to set a range.

oneYearEmployeeGrowthRateMax

String

Maximum one year employee growth rate for a company. Use with oneYearEmployeeGrowthRateMin to set a range.

twoYearEmployeeGrowthRateMin

String

Minimum two year employee growth rate for a company. Use with twoYearEmployeeGrowthRateMax to set a range.

twoYearEmployeeGrowthRateMax

String

Maximum two year employee growth rate for a company. Use with twoYearEmployeeGrowthRateMin to set a range.

positionStartDateMin

String

Minimum date for when a contact began current employment. Use with positionStartDateMax to set a range.

positionStartDateMax

String

Maximum date for when a contact began current employment. Use with positionStartDateMin to set a range.

webReferences

Array

List of web references for a contact. Default criteria is OR between multiple values. Should only contain english letters and numbers.

filterByBuyingCommittee

Boolean

Boolean flag for Buying Committee. Setting this to TRUE will filter the results based on the Buying Committees set for the account. Default is FALSE.

techSkills

ArrayList

List of technology skills for a contact. Default criteria is OR between multiple values. Should only contain string numbers

yearsOfExperience

String

Years of overall experience. Must be a comma-separated string of the values found at /lookup/years-of-experience

Outputs (what you get)

Name

Description

Data Type

Required?

Example

First name

Contact first name

Text(Short)

Optional

John

Middle name

Contact middle name

Text(Short)

Optional

Robert

Last name

Contact last name

Text(Short)

Optional

Smith

Email

Work email address for the contact in example@example.com format

Email

Optional

john.smith@example.com

Phone

Contact direct phone number

Phone

Optional

+1 (123) 456-7890

Direct phone do not call?

Contact flagged with "do not call" for direct phone

True/False

Optional

false

Street

Street for the contact's work address

Text(Short)

Optional

123 Main Street

City

City for the contact's work address

Text(Short)

Optional

New York

Zip code

Zip Code or Postal Code for the contact's work address

Text(Short)

Optional

10001

State

State or province for the contact's work address

Text(Short)

Optional

California

Country

Country for the contact's work address

Text(Short)

Optional

United States

Last validated date

Date on which the contact record was last validated

Date

Optional

2023-07-15

Last updated date

Date on which the contact record was last updated

Date

Optional

2023-07-22

Salutation

Contact salutation

Text(Short)

Optional

Mr.

Suffix

Contact suffix

Text(Short)

Optional

Jr.

Job title

Contact job title at the current place of employment

Text(Short)

Optional

Marketing Manager

Department

Contact department at the current place of employment

List of Text

Optional

["C-Suite"]

Job function

Contact job function at the current place of employment

List of Text

Optional

[“Executive"]

Education

Contact education details in JSON format

Text(Long)

Optional

[{"school": "University of Nevada , Las Vegas","educationDegree": {"degree": "", "areaOfStudy": ""}}]

Picture link

The URL which can be used to retrieve a photo for the contact

Url

Optional

http://example.com/john_smith.jpg

Mobile phone do not call?

Contact flagged with "do not call" for mobile phone

True/False

Optional

true

Facebook link

Facebook link for the contact

Url

Optional

https://www.facebook.com/john.smith

Twitter link

Twitter handle link for the contact

Url

Optional

https://twitter.com/johnsmith/

Linkedin link

Linkedin profile for the contact

Url

Optional

https://www.linkedin.com/in/johnsmith/

Employment history

Contact employment history in JSON format

Text(Long)

Optional

[{"jobTitle": "Vice President of Data and Marketing","managementLevel": ["VP-Level"],"fromDate": "2002-01-02T00:00:00.000Z","toDate": "2006-01-02T00:00:00.000Z","company": {"companyId": 0,"companyName": "iProfile","companyPhone": "","companyWebsite": ""}}]

Management level

Contact management level

List of Text

Optional

["VP-Level"]

Contact accuracy score

This score indicates the likelihood that a contact is reachable and still employed by the company listed. Minimum score is 75 and maximum is 99.

Integer

Optional

88

Company name

Name of the contact's current company

Text(short)

Optional

XYZ Corporation

Company website

URL to the company website in http://www.example.com format

Link

Optional

http://www.xyzcorp.com

Current position start date

The date on which the contact began their current employment

Date

Optional

2022-02-15

Years of experience

Years of overall experience

Integer

Optional

10

Tech skills

A comma-separate list of the technology skills identified for a contact

List of Text

Optional

Python, Java, SQL, Machine Learning


Outcomes

Name

Description

Impossible To Complete

This status is selected in the event of the following scenarios:

  • The external system is not accessible

Requirements

  • N/A


Did this answer your question?