API Documentation
-
1. API Overview
The ZoomInfo API allows third parties to integrate ZoomInfo's people and company search functionality. The API Documentation covers all aspects of the ZoomInfo API. If you have any questions, please email API@zoominfo.com
-
2. Limits and Restrictions
-
2.1 Overview
ZoomInfo sets limits and restrictions to the type and amount of content available via the API on a per user basis. Users have a default max setting of 2,000 API calls per day, per API key. If you need a higher limit, access to additional data, or additional search capabilities please contact us at API@zoominfo.com
-
-
3. Authentication
-
3.1 Overview
Every user is provided with an API Key that they will use as part of each request to the Zoominfo application.
-
-
4. Queries - People Information
-
4.1 People Search
-
4.1.1 Overview
Returns search result of people based on criteria of various search inputs. Please refer to the Person Query and Person Detail schemas for how to interpret the results.
-
4.1.2 Input Parameters
Field Name
Required?
Value
Notes
Key
query_type
required
people_search_query
Will return a set of search results based on search criteria
no
pc
required
<your API Key>
The API Key assigned to you
no
SortBy
optional
Designates what to sort the search results by
no
SortOrder
optional
asc or desc
Default value is asc
no
firstName
optional
<query dependent>
The first name of the person being searched for
yes
lastName
optional
<query dependent>
The last name of the person being searched for
yes
EmailAddress
optional
<query dependent>
Searches for people based on email address
yes
-
4.1.3 Example Query
An example people search: Search for Jonathan SternExample Query Request:
http://api.zoominfo.com/PartnerAPI/XmlOutput.aspx?query_type=people_search_query&pc=<your key>&firstName=Jonathan&lastName=Stern
Example Return XML:
<?xml version="1.0" encoding="utf-8"?> <PeopleSearchRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://partners.zoominfo.com/PartnerAPI/XSD/PeopleQuery.xsd"> <SearchParameters> <Parameter> <Name>firstname</Name> <Value>Jonathan</Value> </Parameter> <Parameter> <Name>lastname</Name> <Value>Stern</Value> </Parameter> </SearchParameters> <TotalResults>100</TotalResults> <PeopleSearchResults> <PersonRecord> <PersonID>457877</PersonID> <ZoomPersonUrl>http://www.zoominfo.com/Search/PersonDetail.aspx?PersonID=457877&pc=publicapi</ZoomPersonUrl> <LastMentioned>1/21/2008</LastMentioned> <IsUserPosted>True</IsUserPosted> <IsPast>False</IsPast> <ReferencesCount>496</ReferencesCount> <ImageUrl>http://www.zoominfo.com/Search/PersonImage.aspx?DefaultImageSource=http://www.zoominfo.com/images/transparent.gif&AccountID=5108&ImageSource=http://www.zoominfo.com/About/i/photo_yonatan.jpg</ImageUrl> <FirstName>Jonathan</FirstName> <LastName>Stern</LastName> <CurrentEmployment> <JobTitle>Founder and Chief Executive Officer</JobTitle> <Company> <CompanyID>220414003</CompanyID> <ZoomCompanyUrl>http://www.zoominfo.com/Search/CompanyDetail.aspx?CompanyID=220414003&cs=QCNI0AzZA&pc=publicapi</ZoomCompanyUrl> <CompanyName>Zoom Information Inc</CompanyName> </Company> </CurrentEmployment> </PersonRecord> <PersonRecord> <PersonID>7821970</PersonID> <ZoomPersonUrl>http://www.zoominfo.com/Search/PersonDetail.aspx?PersonID=7821970&pc=publicapi</ZoomPersonUrl> <LastMentioned>1/28/2008</LastMentioned> <IsUserPosted>False</IsUserPosted> <IsPast>False</IsPast> <ReferencesCount>313</ReferencesCount> <ImageUrl>http://www.zoominfo.com/Search/PersonImage.aspx?DefaultImageSource=http://www.zoominfo.com/images/transparent.gif&ImageSource=http://www.energydelta.nl/repository/news/stern.jpg</ImageUrl> <FirstName>Jonathan</FirstName> <LastName>Stern</LastName> <CurrentEmployment> <JobTitle>Director of Gas Research</JobTitle> <Company> <CompanyID>68076922</CompanyID> <ZoomCompanyUrl>http://www.zoominfo.com/Search/CompanyDetail.aspx?CompanyID=68076922&cs=QFEDsV6%401g&pc=publicapi</ZoomCompanyUrl> <CompanyName>Oxford Institute for Energy Studies</CompanyName> </Company> </CurrentEmployment> </PersonRecord> <PersonRecord> <PersonID>27704460</PersonID> <ZoomPersonUrl>http://www.zoominfo.com/Search/PersonDetail.aspx?PersonID=27704460&pc=publicapi</ZoomPersonUrl> <LastMentioned>10/31/2007</LastMentioned> <IsUserPosted>False</IsUserPosted> <IsPast>False</IsPast> <ReferencesCount>136</ReferencesCount> <ImageUrl/><FirstName>Jonathan</FirstName> <LastName>Stern</LastName> <CurrentEmployment> <JobTitle>Producers</JobTitle> <Company> <CompanyID>0</CompanyID> <CompanyName/> </Company> </CurrentEmployment> </PersonRecord> <PersonRecord> <PersonID>94968218</PersonID> <ZoomPersonUrl>http://www.zoominfo.com/Search/PersonDetail.aspx?PersonID=94968218&pc=publicapi</ZoomPersonUrl> <LastMentioned>11/1/2007</LastMentioned> <IsUserPosted>False</IsUserPosted> <IsPast>False</IsPast> <ReferencesCount>103</ReferencesCount> <ImageUrl/> <FirstName>John</FirstName> <LastName>Stern</LastName> <CurrentEmployment> <JobTitle>Executive Director</JobTitle> <Company> <CompanyID>74614477</CompanyID> <ZoomCompanyUrl>http://www.zoominfo.com/Search/CompanyDetail.aspx?CompanyID=74614477&cs=QFEcobN%401g&pc=publicapi</ZoomCompanyUrl> <CompanyName>Neighborhoods Resource Center</CompanyName> </Company> </CurrentEmployment> </PersonRecord> ... </PeopleSearchResults> </PeopleSearchRequest> -
4.1.4 Output Parameters
Group Name
Children Name
Notes
PersonID
The unique identifier for the individual person
ZoomSummaryURL
Link to person’s zoominfo.com public profile
PersonDetailXmlUrl
API request url for person_detail. Returned output will be in XML format
LastMentioned
The date the person’s profile was last updated
IsUserPosted
Designates if the profile was manually created by the person
IsPast
Designates if the most recent job title we have for a person is a past position
ReferencesCount
The number of web references the person has
ImageUrl
The URL to the person’s profile image
FirstName
First name of the individual
LastName
Last name of the individual
CurrentEmployment
The current company the individual is employed with. CurrentEmployment Contains 3 child elements.
JobTitle
The person’s title at their current place of employment
Company
Contains 9 child elements with information about the individuals current company of employment
CompanyID
The unique identifier used by ZoomInfo for companies
CompanyName
The name of the company
-
-
-
5. Queries - Company Information
-
5.1 Company Search
-
5.1.1 Overview
"Returns search result of companies based on input criteria. Available search inputs and returned output is restricted by access rights for public accounts. Please refer to the Company Query schema for how to interpret the results.
-
5.1.2 Input Parameters
Field Name
Required?
Value
Notes
Key
query_type
required
company_search_query
Will return a set of search results based on search criteria
no
pc
required
<your API Key>
The API Key assigned to you
no
SortBy
optional
Designates what to sort the search results by
no
SortOrder
optional
asc or desc
Default value is asc
no
companyName
optional
<query dependent>
The name of the company being searched for. Will also accept a stock ticker or website domain as input
companyDesc
optional
<query dependent>
The industry, product, or service keyword that helps describe what a company does
yes
IndustryClassification
optional
An alternative to industry keyword search. A stricter hierarchy of industries. See list of industry codes here. Accepts multiple values by passing a comma separated list
yes
RevenueClassificationMin
optional
The minimum revenue amount of a company. Can be used with RevenueClassificationMax to set a range.
yes
RevenueClassificationMax
optional
The maximum revenue amount of a company. Can be used with RevenueClassificationMin to set a range.
yes
EmployeeSizeClassificationMin
optional
The minimum employee size of a company. Can be used with EmployeeSizeClassificationMax to set a range
yes
EmployeeSizeClassificationMax
optional
The maximum employee size of a company. Can be used with EmployeeSizeClassificationMin to set a range
yes
IsPublic
optional
<blank>, “Public”, “Private”
Restricts searches to just public or private companies. Leave blank to search for public and private companies
yes
CompanyRanking
optional
Restricts searches to a specific company ranked list i.e. Fortune 500 Accepts multiple values by passing a comma separated list
yes
State
optional
Restricts searches to one or more US states. Accepts multiple values by passing a comma separated list
yes
MetroRegion
optional
Restricts searches to one or more metro regions. Accepts multiple values by passing a comma separated list
yes
Country
optional
Restricts to one or more countries. The only available countries are USA, UK, Canada, and Australia. Accepts multiple values by passing a comma separated list
yes
ZipCode
optional
An integer, and 0 if not available
yes
RadiusMiles
optional
Used in conjunction with ZipCode, designates how far in miles from zip code to include in search
yes
AddressType
optional
<blank>, 0 also see here
Designates what address to apply the geography search to. <blank> = Company – Headquarters Address, 0 = Company – All Addresses
yes
-
5.1.3 Example Query
An example company search:
Internet Search companies in the state of Massachusetts
Example Query Request:
http://api.zoominfo.com/PartnerAPI/XmlOutput.aspx?query_type=company_search_query&pc=<your key>&companyDesc=Internet+Search&State=MA
Example Return XML:
<?xml version="1.0" encoding="utf-8"?> <CompanySearchRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://partners.zoominfo.com/PartnerAPI/XSD/CompanyQuery.xsd"> <SearchParameters> <Parameter> <Name>state</Name> <Value>1442052</Value> </Parameter> <Parameter> <Name>companydesc</Name> <Value>Internet Search</Value> </Parameter> </SearchParameters> <TotalResults>2</TotalResults> <CompanySearchResults> <CompanyRecord> <CompanyID>23052630</CompanyID> <ZoomCompanyUrl>http://www.zoominfo.com/Search/CompanyDetail.aspx?CompanyID=23052630&cs=QDBX8FWI0&pc=Test</ZoomCompanyUrl> <CompanyName>LookSmart , Ltd.</CompanyName> <CompanyTicker>NASDAQ: LOOK</CompanyTicker> <Website>www.looksmart.com</Website> <CompanyAddress> <City>San Francisco</City> <State>CA</State> <CountryCode>USA</CountryCode> </CompanyAddress> <CompanyDescription>LookSmart helps more than 35,000 businesses harness the power of Internet search to generate qualified leads.</CompanyDescription> <Industry>Media & Internet</Industry> <Industry>Search Engines & Internet Portals</Industry> </CompanyRecord> <CompanyRecord> <CompanyID>11505325</CompanyID> <ZoomCompanyUrl>http://www.zoominfo.com/Search/CompanyDetail.aspx?CompanyID=11505325&cs=QDr46tSY&pc=Test</ZoomCompanyUrl> <CompanyName>Ask Jeeves , Inc.</CompanyName> <CompanyTicker /> <Website>www.ask.com</Website> <CompanyAddress> <City>Emeryville</City> <State>CA</State> <CountryCode>USA</CountryCode> </CompanyAddress> <CompanyDescription>ASK JEEVES, ASK.COM and the JEEVES DESIGN are service marks of Ask Jeeves, Inc. All other brands are property of their respective owners. Patent pending.</CompanyDescription> <Industry>Media & Internet</Industry> <Industry>Search Engines & Internet Portals</Industry> </CompanyRecord> </CompanySearchResults> </CompanySearchRequest> -
5.1.4 Output Parameters
Group Name
Children Name
Notes
CompanyID
The unique identifier used by zoom for companies
ZoomCompanyUrl
The URL to the company profile on zoominfo.com public site
CompanyName
The full name of the company
CompanyTicker
The company’s public stock exchange ticker
Website
The web domain for the company in http://www.example.com format
CompanyAddress
Contains 5 child elements describing the company’s primary address
Street
The street address for the company’s primary address
City
The primary city for the company
State
A defined two letter code for the state. For a list of state codes click here.
Zip
The zip code of the company’s primary address
CountryCode
A defined code for a country. Only 4 countries available. For a list click here.
CompanyDescription
A short paragraph describing the main purpose of the company
Industry
An industry grouping for the company. A company can have multiple industries.
-
-
5.2 Company Detail
-
5.2.1 Overview
Returns a wide array of company specific information for each company unique identifier passed. Data returned is limited to access rights set for public accounts. Please refer to the Company Detail schema for how to interpret the results."
-
5.2.2 Input Parameters
Field Name
Required?
Value
Notes
Key
query_type
required
company_detail
Will return a set of search results based on search criteria
no
pc
required
<your API Key>
The API Key assigned to you
no
CompanyID
cid or email
<query dependent>
The individual company’s zoom id
yes
CompanyDomain
cid or email
<query dependent>
Company’s website domain address
yes
-
5.2.3 Example Query
An example company detail request:The company with the domain of www.ibm.comExample Query Request:http://api.zoominfo.com/PartnerAPI/XmlOutput.aspx?query_type=company_detail&pc=<your key>&CompanyDomain=www.ibm.com
Example Return XML (the data in this example was manually altered from the actual result):<?xml version="1.0" encoding="utf-8"?> <CompanyDetailRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://partners.zoominfo.com/PartnerAPI/XSD/CompanyDetail.xsd"><CompanyID>18579882</CompanyID> <ZoomCompanyUrl>http://www.zoominfo.com/Search/CompanyDetail.aspx?CompanyID=18579882&cs=QHBG4GqLA&pc=Test</ZoomCompanyUrl> <CompanyName>IBM Corporation</CompanyName> <CompanyTicker>NYSE: IBM</CompanyTicker> <Phone>(555) 555-1900</Phone> <Fax>(555) 555-2188</Fax> <Website>www.ibm.com</Website> <CompanyAddress> <Street>North Castle Drive</Street> <City>Armonk</City> <State>NY</State> <Zip>10504-1785</Zip> <CountryCode>United States</CountryCode> </CompanyAddress> <OtherCompanyAddress> <Street>North Castle Drive</Street> <City>Armonk</City> <State>NY</State> <Zip>10504-1785</Zip> </OtherCompanyAddress> <Industry>Software</Industry> <Industry>Software Development & Design</Industry> <CompanyDescription>IBM is the world's largest information technology company, with 80 years of leadership in helping businesses innovate. Drawing on resources from across IBM and key IBM Business Partners, IBM offers a wide range of services, solutions and technologies that enable customers, large and small, to take full advantage of the new era of on demand business.</CompanyDescription> <MergerAcquisition> <CompanyID>262836</CompanyID> <ZoomCompanyUrl>http://www.zoominfo.com/Search/CompanyDetail.aspx?CompanyID=262836&cs=QEBAK0CM&pc=Test</ZoomCompanyUrl> <CompanyName>Access360</CompanyName> </MergerAcquisition> <CompanyRanking>global 500</CompanyRanking> <CompanyRanking>fortune 100</CompanyRanking> <KeyPerson> <PersonID>534311</PersonID> <ZoomPersonUrl>http://www.zoominfo.com/Search/PersonDetail.aspx?PersonID=534311&pc=Test</ZoomPersonUrl> <FirstName>Sam</FirstName> <LastName>Palmisano</LastName> <JobTitle>Chairman and Chief Executive Officer</JobTitle> </KeyPerson> </CompanyDetailRequest> -
5.2.4 Output Parameters
All output data points except default are dependent on your access rights to the company_detail query.
Group Name
Children Name
Notes
CompanyID
The unique identifier used by zoom for companies
ZoomCompanyURL
The URL to the company profile on zoominfo.com public site
CompetitorsXmlUrl
API request for the company's competitors. Returned in XML format. Will only appear if your account has access to the company_competitors API.
CompetitorsHtmlUrl
API request for the company's competitors. Returned in HTML format. Will only appear if your account has access to the company_competitors API.
CompanyName
The name of the company
CompanyTicker
The stock ticker for the company if available
Phone
The primary phone number for the company
Fax
The primary fax number for the company
Website
The web domain for the company in http://www.example.com format
CompanyAddress
Contains 5 child elements describing the company’s primary address
Street
The street address for the company’s primary address
City
The primary city for the company
State
A defined two letter code for the state. For a list of state codes click here.
Zip
The zip code of the company’s primary address
CountryCode
A defined code for a country. Only 4 countries available. For a list click here.
OtherCompanyAddresses
Contains 5 child elements describing a company’s secondary address. A company who has branches or multiple offices will commonly have multiple OtherCompanyAddresses
Street
The street address for the company’s other address
City
The city for a possible address for the company
State
A defined two letter code for the state. For a list of state codes click here.
Zip
An integer, and 0 if not available
CountryCode
A defined code for a country. Only 4 countries available. For a list click here.
Industry
An industry grouping for the company. A company can have multiple industries.
CompanyDescription
A short paragraph describing the main purpose of the company
MergerAcquisition
Contains 5 child elements of a company that has been involved in a merger or acquisition with requested company
CompanyID
The zoom unique identifier for the company
ZoomCompanyURL
The URL to the company’s zoominfo.com public site summary
CompanyName
The name of the company that was involved in M&A activity with the parent company
CompanyRanking
A ranked company list the company has appeared in (i.e. Fortune 500). A company can belong to more then one ranked list
KeyPerson
A person who has been identified as part of the executive team of the company. KeyPerson contains 7 child elements
PersonID
The unique identifier used by zoom
ZoomPersonUrl
Link to person’s zoominfo.com public profile
FirstName
The first name of the person
LastName
The last name of the person
JobTitle
The title the person holds at this company
SummaryStatistics
Views
The number of times a person’s public site profile has been viewed
Forwards
The number of times a person’s public site profile has been forwarded via email
QuickLists
The number of times a person has been added to a person’s ZoomInfo Quick List
-
-
5.3 Company Competitors
-
5.3.1 Overview
Returns a list of competitor companies for each company unique identifier passed. Note that unlike the key for all other queries where you prefix the first two characters of each query parameter to the key, you must prefix the entire CompanyID to the key prior to encoding with MD5.
-
5.3.2 Input Parameters
Field Name
Required?
Value
Notes
Key
query_type
required
company_competitors
Will return a set of search results based on search criteria
no
pc
required
<your API Key>
The API Key assigned to you
no
CompanyID
cid or email
<query dependent?
The individual company’s zoom id
yes
CompanyDomain
cid or email
<query dependent>
Company’s website domain address
yes
-
5.3.3 Example Query String
(IBM)An example company competitors query:
The competitors of the company with a unique ID of 18579882
Example Query Request:
http://api.zoominfo.com/PartnerAPI/XmlOutput.aspx?query_type=company_competitors&pc=<your key>&CompanyID=18579882
Example Return XML:
<?xml version="1.0" encoding="utf-8"?> <CompanySearchRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://partners.zoominfo.com/PartnerAPI/XSD/CompanyQuery.xsd"> <SearchParameters> <Parameter> <Name>companyid</Name> <Value>18579882</Value> </Parameter> </SearchParameters> <TotalResults>2</TotalResults> <CompanySearchResults> <CompanyRecord> <CompanyID>37290422</CompanyID> <ZoomCompanyUrl>http://www.zoominfo.com/Search/CompanyDetail.aspx?CompanyID=37290422&cs=QECOQG2VU&pc=Test</ZoomCompanyUrl> <CompanyName>Symantec Corporation</CompanyName> <CompanyTicker>NASDAQ: SYMC</CompanyTicker> <Website>www.symantec.com</Website> <CompanyAddress> <City>Cupertino</City> <State>CA</State> <CountryCode>USA</CountryCode> </CompanyAddress> <CompanyDescription>Symantec is the world leader in providing solutions to help individuals and enterprises assure the security, availability, and integrity of their information. Headquartered in Cupertino, Calif., Symantec has operations in more than 40 countries.</CompanyDescription> <Industry>Software</Industry> <Industry>Software Development & Design</Industry> </CompanyRecord> <CompanyRecord> <CompanyID>2441797</CompanyID> <ZoomCompanyUrl>http://www.zoominfo.com/Search/CompanyDetail.aspx?CompanyID=2441797&cs=QFJUJFFI&pc=Test</ZoomCompanyUrl> <CompanyName>Apple Computer , Inc.</CompanyName> <CompanyTicker>NASDAQ: AAPL</CompanyTicker> <Website>www.apple.com</Website> <CompanyAddress> <City>Cupertino</City> <State>CA</State> <CountryCode>USA</CountryCode> </CompanyAddress> <CompanyDescription>Written and designed by Apple in Cupertino, Apple eNews is a free, bi-weekly email publication. Event dates are subject to change.</CompanyDescription> <Industry>Manufacturing</Industry> <Industry>Computer Equipment & Peripherals</Industry> <Industry>Personal Computers & Peripherals</Industry> </CompanyRecord> </CompanySearchResults> </CompanySearchRequest> -
5.3.4 Output Parameters
Group Name
Children Name
Notes
CompanyID
The unique identifier used by zoom for companies
ZoomCompanyUrl
The URL to the company profile on zoominfo.com public site
CompanyName
The full name of the company
CompanyTicker
The company’s public stock exchange ticker
Website
The web domain for the company in http://www.example.com format
CompanyAddress
Contains 5 child elements describing the company’s primary address
Street
The street address for the company’s primary address
City
The primary city for the company
State
A defined two letter code for the state. For a list of state codes click here.
Zip
The zip code of the company’s primary address
CountryCode
A defined code for a country. Only 4 countries available. For a list click here.
CompanyDescription
A short paragraph describing the main purpose of the company
Employees
The approximate number of people employed by the company
-
-