Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ekohe/zoominfo-js-client
The ZoomInfo Client Library provides a streamlined way to interact with the ZoomInfo API for searching and enriching company and contact information. Built in TypeScript/JavaScript, this library simplifies making API requests and handling responses, allowing developers to easily integrate ZoomInfo's capabilities into their applications.
https://github.com/ekohe/zoominfo-js-client
js js-library typescript zoominfo zoominfo-client
Last synced: about 1 month ago
JSON representation
The ZoomInfo Client Library provides a streamlined way to interact with the ZoomInfo API for searching and enriching company and contact information. Built in TypeScript/JavaScript, this library simplifies making API requests and handling responses, allowing developers to easily integrate ZoomInfo's capabilities into their applications.
- Host: GitHub
- URL: https://github.com/ekohe/zoominfo-js-client
- Owner: ekohe
- License: mit
- Created: 2024-04-24T06:40:58.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-08-07T13:06:22.000Z (5 months ago)
- Last Synced: 2024-08-07T15:49:11.544Z (5 months ago)
- Topics: js, js-library, typescript, zoominfo, zoominfo-client
- Language: TypeScript
- Homepage:
- Size: 16.6 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ZoomInfo Client Library
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:
```bash
yarn add https://github.com/ekohe/zoominfo-js-client
```
## Usage
### Initialization
Import and initialize the client:
```javascript
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.
```javascript
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.
```javascript
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.
```javascript
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](./types.ts) file.
## License
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.