Skip to content

Latest commit

 

History

History
85 lines (58 loc) · 2.24 KB

README.md

File metadata and controls

85 lines (58 loc) · 2.24 KB

ZoomInfo Client - JS Library (2024 Active)

The ZoomInfo Client Library is a TypeScript/JavaScript library for interacting with the ZoomInfo API. This library facilitates operations for searching companies and contacts, as well as enriching contact information.

Features

  • Company Search: Search for companies using various parameters.
  • Contact Search: Search for contacts based on specific criteria.
  • Contact Enrichment: Enrich contact information with additional details.

Installation

To add the ZoomInfo Client Library to your project, run:

yarn add https://github.com/ekohe/zoominfo-js-client

Usage

Initialization

Import and initialize the client:

import ZoomInfoClient from 'zoominfo-js-client';

const client = ZoomInfoClient({
  handleBaseURL: (baseURL) => `${baseURL}`
});

Methods

companySearch(params, token)

Search for companies based on provided parameters.

  • Parameters:
    • params (CompanySearchParams): Search criteria for companies.
    • token (string): The API token.
  • Returns: Promise with search results.
client.companySearch(searchParams, token)
  .then(response => console.log(response))
  .catch(error => console.error(error));

contactSearch(params, token)

Search for contacts based on provided parameters.

  • Parameters:
    • params (ContactSearchParams): Search criteria for contacts.
    • token (string): The API token.
  • Returns: Promise with search results.
client.contactSearch(searchParams, token)
  .then(response => console.log(response))
  .catch(error => console.error(error));

contactEnrich(params, token)

Enrich contact information with additional details.

  • Parameters:
    • params (ContactEnrichParams): Data to enrich a contact.
    • token (string): The API token.
  • Returns: Promise with enriched contact data.
client.contactEnrich(enrichParams, token)
  .then(response => console.log(response))
  .catch(error => console.error(error));

Documentation

For detailed information on request and response formats, refer to the types file.

License

This project is licensed under the MIT License. See the LICENSE file for details.