{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"3859e5f7-4b34-47e3-b3f8-d28c20a8d457","name":"ZoomInfo API - Legacy","description":"Note: This page provides documentation on the Legacy ZoomInfo Enterprise API. This API is currently in the process of being deprecated. All new development to ZoomInfo APIs should be done on the new API. Documentation for this new API can be found here:\n\n[https://docs.zoominfo.com](https://docs.zoominfo.com)\n\nWelcome to ZoomInfo's API. ZoomInfo is the leading data intelligence platform for B2B go-to-market teams, presenting a trifecta of the broadest, deepest and highest quality B2B data.\n\nUse the API to query the ZoomInfo database for relevant companies and contacts and enrich the data records in your Customer Relationship Management (CRM), Marketing Automation (MA), and other systems in your organization. The API helps you build out your organization's contact and company records by tapping in-depth information such as technologies used, company attributes, corporate hierarchies, funding details, news alerts and scoops, and more. This deep data enables teams to build sophisticated, refined, and targeted prospect segments, as well as improve campaign list building, prospecting, lead routing, scoring, and territory alignment.\n\n# API structure\n\nThe ZoomInfo API is a set of HTTPS endpoints you can use to programmatically retrieve and integrate ZoomInfo data into your existing technology stack and workflows. Responses are returned in JSON to support integration with common programming languages and development kits.\n\nThe Enterprise API supports searching for and enriching company and contact records, and are comprised as follows:\n\n**Standard APIs**\n\n- The [Search API](#20219386-4c34-485e-a859-c697d64f2ae9) accepts various input criteria which are used to return Contacts, Companies, Scoops, News and Intent records. The purpose of Search is to cast a wide net, returning a list of records that meet the input criteria. The records returned are previews of the full ZoomInfo profile. Use the Enrich API endpoints to return ZoomInfo's full profile for any record.\n    \n- The [Enrich API](#4c495fb6-68df-44bb-8703-0616f81cfdcb) is used to retrieve ZoomInfo's full profile data by matching to known contacts or companies. Use the Enrich endpoints to redeem full profiles returned from Search queries, or enrich your existing database of contacts and companies with ZoomInfo data.\n    \n- The [Lookup API](#efe7b4b8-1ef2-4fcd-a20f-9da68f6b2055) includes a set of endpoints that return available inputs and outputs for corresponding Search or Enrich requests. Use the Input Lookup endpoints to help select the input criteria supported by the different requests. The Lookup Output endpoints provide a full list of fields returned by each endpoint.\n    \n- The [Usage API](#ec3704c0-8898-4ba7-baf4-c45b46ef80d3) lets you check your current API usage and limits.\n    \n\n**Scaling APIs**\n\n- The [Webhooks API](#0a3012d3-546c-45bd-9a3c-d014b93ce47e) is a set of endpoints that lets you configure webhooks subscriptions to automate the update of records - listening for events you subscribe to, and sending updates securely to your application.\n    \n- The [Bulk API](#00c2d0c8-d0f6-4904-a5b1-495675e13189) is a set of endpoints that provide bulk search and redeem capabilities for Contacts and Companies, enabling the search and retrieval of large ZoomInfo Company and Contact datasets at scale through asynchronous batch processes.\n    \n\n**WebSights API**\n\nThe [WebSights API](#9e5ec7b8-5cef-40ee-86f3-105be2194fe7) identifies anonymous website traffic by resolving IP addresses to return company and ISP profiles and IP Geolocation details.\n\n**Compliance API**\n\nThe [Compliance API](#8631bd5c-4435-4fb4-9d4f-91b73cf7e89e) includes endpoints related to data privacy and opt-out compliance for contacts stored in the ZoomInfo database.\n\n# Authentication methods\n\nThe API supports the following authentication methods:\n\n- Private Key Infrastructure (PKI)\n    \n- Username and password\n    \n\nFor both authentication methods, a Java Web Token (JWT) is returned which can be programmatically or manually used to access the API.\n\n## Public Key Infrastructure (PKI) authentication\n\nThe preferred authentication method is to obtain a Client ID and Private key pair and a public library to programmatically generate a JWT that is valid for one hour. To do this:\n\n1. Log in to the ZoomInfo GUI using admin credentials with API access.\n    \n2. Go to **Admin Portal** > **API** and click **Generate New Key**. You are provided with a Client ID and a Private Key.\n    \n3. Import a public library that authenticates using this Client ID and Private Key and generates a JWT.\n    \n\nZoomInfo provides supported PKI authentication libraries for Java, Python and NodeJS in [Github](https://github.com/Zoominfo).\n\n## Username and password authentication\n\nYou can use the [Authentication endpoint](#ea1ebd5d-8b4a-412f-a8c8-3d8b8e123407) to manually supply your username and password, returning a JWT that is valid for one hour.\n\nA developer can alternatively import a public library that authenticates a username and password to return a JWT. ZoomInfo provides supported username and password authentication libraries for Java, Python and NodeJS in [Github](https://github.com/Zoominfo).\n\n# Rate and usage limits\n\nThe ZoomInfo API uses rate and usage limits tied to the account provisioned for API access. Your API account is provisioned with:\n\n- **Rate limits**: A limit to the number of requests you can make within a given time period.\n    \n    - For the Authentication endpoint, the limit is 1 request per second.\n        \n    - For the Standard APIs, WebSights API, and Compliance API, the limit is 25 requests per second (1500 request per minute).\n        \n    - For the Scaling APIs, the limit is 33 requests per second (2000 requests per minute)\n        \n- **Request limits**: An overall number of requests you can perform within the current API contract term.\n    \n- **Record limits**: The number of records you are entitled to retrieve within the current API contract term.\n    \n\nYou can track usage status using the [Usage Lookup endpoint](#ec3704c0-8898-4ba7-baf4-c45b46ef80d3).\n\nYou can also track usage using the response headers of each API call (with the exception of the Authentication and Lookup endpoints).\n\n| Parameter | Sample Value | Description |\n| --- | --- | --- |\n| X-RateLimit-Limit | 1500 | The maximum number of requests you're permitted to make per minute |\n| X-RateLimit-Remaining | 999 | The number of requests remaining in the current rate limit window |\n| X-RateLimit-Reset | 1583161964 | The time at which the current rate limit window resets in [UTC epoch seconds](https://en.wikipedia.org/wiki/Unix_time) |\n| X-Usage-Record-Limit-Limit | 10000000 | The maximum number of records you can retrieve within the current API contract term |\n| X-Usage-Record-Limit-Remaining | 878530 | The remaining number of records you can retrieve within the current API contract term |\n| X-Usage-Request-Limit-Limit | 10000000 | The maximum number of requests you can make within the current API contract term. If using the Scaling API, this value will display \"-1\", as there are no limits to the total number of API requests you can make (provided you do not exceed the rate limit of 33 requests per second). |\n| X-Usage-Request-Limit-Remaining | 949262 | The number of requests remaining within the current API contract term |\n| X-Usage-Unique-Id-Limit-Limit | 100000 | The maximum number of person or company records you can redeem within the current API contract term. The limit for each API user is set in the Admin Portal. |\n| X-Usage-Unique-Id-Limit-Remaining | 84994 | The number of person or company records remaining to redeem within the current API contract term |\n| X-Usage-Websights-Api-Record-Limit-Limit | 10000000 | The max number of WebSights records you can retrieve within the current API contract term |\n| X-Usage-Websights-Api-Record-Limit-Remaining | 9999997 | The remaining number of WebSights records you can retrieve within the current API contract term |\n| X-Usage-Websights-Api-Request-Limit-Limit | 100000000 | The maximum number of WebSights requests you can make within the current API contract term |\n| X-Usage-Websights-Api-Request-Limit-Remaining | 99999997 | The number of WebSights requests remaining within the current API contract term |\n\n# Error handling and troubleshooting\n\n## HTTP status codes\n\nThe API will return standard classes of HTTP error status codes (4xx client and 5xx server codes) as well as 2xx success codes.\n\n## Common errors\n\nThe API will also return error messages specific to the request being performed. These error messages indicate a possible reason for a request failure. The following table lists common error messages and potential user actions to resolve.\n\n| Code | Error message | Action |\n| --- | --- | --- |\n| 400 | Exceeded the max limit to enrich new Contacts or Companies | See the rate and usage limiting data in the response header. Refer to \"Rate and usage limiting\" for details. |\n| 400 | Missing outputFields parameter | Some requests (specifically the Enrich API) require at least one `outputfields` parameter to be specified |\n| 400 | No roles found for login | Contact your ZoomInfo sales representative. |\n| 400 | Page number (page) is not a number | Ensure that the value conforms to the correct data type (integer) |\n| 400 | Page number (page) requested is greater than the available results | Input a page number that falls within the results per page (rpp) and total results |\n| 400 | Request body has malformed JSON | Check the request JSON for proper syntax |\n| 400 | Results per page (rpp) is not a number | Ensure that the value conforms to the correct data type (integer) |\n| 400 | Results per page (rpp) is over max allowed value (100) | The number of returned objects exceeds the maximum allowed value of 100 |\n| 400 | The parameter passed for sortBy is invalid | Results can only be sorted on specific fields. See the endpoint field descriptions for valid sortBy options. |\n| 400 | There are invalid fields in your request | Check field names used in the request |\n| 400 | There is insufficient information for this request | Check your request syntax and ensure it meets specifications described for the endpoint |\n| 400 | Total record pagination is over max allowed value (1000) | The number of returned objects exceeds the maximum allowed value of 100 |\n| 401 | Authentication failed | Ensure you are using valid credentials or token |\n| 403 | There are fields that are not allowed under your subscription | Check your subscription details. Contact your ZoomInfo sales representative. |\n| 403 | You do not have access to the enrich endpoint | You are not provisioned to access this endpoint. Contact your ZoomInfo sales representative. |\n| 403 | You do not have access to the search endpoint | You are not provisioned to access this endpoint. Contact your ZoomInfo sales representative. |\n| 403 | You do not have access to this endpoint | You are not provisioned to access this endpoint. Contact your ZoomInfo sales representative. |\n| 403 | You have used up all of your allowed request limit | See the rate and usage limiting data in the response header. Refer to \"Rate and usage limiting\" for details. |\n| 403 | You have used up all of your allowed request limit for WebSights API | See the rate and usage limiting data in the response header. Refer to \"Rate and usage limiting\" for details. |\n| 403 | You have used up all of your allowed record limit | See the rate and usage limiting data in the response header. Refer to \"Rate and usage limiting\" for details. |\n| 403 | You have used up all of your allowed record limit for WebSights API | See the rate and usage limiting data in the response header. Refer to \"Rate and usage limiting\" for details. |\n| 403 | You do not have permission to access the ZoomInfo API | Confirm that your access credentials are valid |\n| 429 | You have exceeded your API query rate limit. Please decrease the frequency of your API requests | See the rate and usage limiting data in the response header. Refer to \"Rate and usage limiting\" for details. |\n| 500 | An unexpected error has occurred. Please try again and if this continues to occur, please contact us and reference the error id provided above | The request could be too large in scope, too long to return, or experiencing a system or network issue. Contact support. |\n| 500 | Search failed. Please try again and if this continues to occur, please contact us and reference the error id provided above | The request could be too large in scope, too long to return, or experiencing a system or network issue. Contact support. |\n\n## Unique request IDs\n\nTo assist with troubleshooting issues with a specific request, a unique ID called `X-Request-Id` is included in the response header of each request.\n\n# Release Notes\n\nView the latest [release notes](#51969d05-46ca-404e-8455-66ff066229d6) for the ZoomInfo API.\n\n# Legal\n\n[Privacy Policy](https://www.zoominfo.com/legal/privacy-policy)\n\n[Terms of Use](https://www.zoominfo.com/legal/terms-of-use)\n\n[Do Not Sell or Share My Personal Information](https://www.zoominfo.com/trust-center/your-privacy)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"973925","collectionId":"3859e5f7-4b34-47e3-b3f8-d28c20a8d457","publishedId":"UVXnFttz","public":true,"publicUrl":"https://api-docs.zoominfo.com","privateUrl":"https://go.postman.co/documentation/973925-3859e5f7-4b34-47e3-b3f8-d28c20a8d457","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"}}]}},"version":"8.12.12","publishDate":"2026-11-03T14:02:14.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://postman-image-service.postman.com/api/cloudinary-proxy/postman/image/upload/t_team_logo_pubdoc/v1/team/cba77eb526d6ae377bedce619c96d9f210069295492f94bc81f955ef177afaa5","favicon":"https://res.cloudinary.com/postman/image/upload/v1571679452/team/v8mh8pgh9azd2eiykvvu.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://api-docs.zoominfo.com/view/metadata/UVXnFttz"}