{"openapi":"3.0.0","info":{"title":"Data API V1","version":"1.0","contact":{"name":"ZoomInfo Customer Support","email":"help@zoominfo.com"},"description":"The Data API"},"tags":[{"name":"Search"},{"name":"Enrich"},{"name":"Lookup"},{"name":"User"}],"paths":{"/data/v1/contacts/search":{"post":{"operationId":"SearchInterface_searchContact","summary":"Search Contacts","description":"Returns a list of Contacts from ZoomInfo's data that meet the specified search criteria.\n\nInput parameters may require specific values. You can use the [Lookup Data](ref:lookupinterface_lookup)\nendpoint to retrieve the list of possible values\n\nThe Search Contacts API does not return emails, phone numbers, or any other data that can be used to engage with\nthe contacts in your results, but the results do include hints for what data ZoomInfo has for a specific contact.\nTo get the additional data for contacts, including emails or phone numbers, use the\n[Enrich Contact API](ref:enrichinterface_enrichcontact)\n\nWith reference to ZoomInfo's [Credit Usage and Limits](doc:credit-usage-and-limits), this endpoint does not\nconsume any credits nor do contacts returned count towards record limits, but each request will increment against your\nrequest limits.","parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page of results that you want to retrieve. If not provided, the first page\nof results will be returned. Use in connection with `page[size]` to handle large result sets.\n\nExample: `page[number]=2&page[size]=25` will return the second page of result (results 26-50 based\non the `sort` value).","schema":{"type":"integer","format":"int32","minimum":1},"explode":false},{"name":"page[size]","in":"query","required":false,"description":"Sets the number of records to return per page. If not provided, the default is 25 records per\npage. Valid values for page size are any integer from 1 to 100.","schema":{"type":"integer","format":"int32","minimum":1,"maximum":100},"explode":false},{"name":"sort","in":"query","required":false,"description":"Sort results by the specified output field. Valid values are contactAccuracyScore, lastName, companyName,\nhierarchy, sourceCount, lastMentioned, and relevance. Add minus sign ('-') for descending order. The default\nvalue if not provided is sorting by relevance in descending order `-relevance`\n\nExamples:\n- `lastName` will sort results by contact last name in ascending alphabetical order.\n- `-lastMentioned` will sort results in descending order (most recently to least recently mentioned)\nby the `lastMentioned` date for each contact","schema":{"type":"string"},"explode":false}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ContactSearchResponse"},"examples":{"Contact search by companyName, firstName, and lastName":{"summary":"Contact search by companyName, firstName, and lastName","description":"This example demonstrates how to search for contacts using the ZoomInfo API utilizing multiple input fields. In this example, the companyName, firstName, and lastName fields are used to find a list of matching contacts.","value":{"data":[{"attributes":{"company":{"id":344589814,"name":"ZoomInfo"},"contactAccuracyScore":95,"directPhoneDoNotCall":false,"firstName":"Filip","hasCompanyCountry":true,"hasCompanyEmployeeCount":true,"hasCompanyIndustry":true,"hasCompanyPhone":true,"hasCompanyRevenue":true,"hasCompanyState":true,"hasCompanyStreet":true,"hasCompanyZipCode":true,"hasDirectPhone":false,"hasEmail":true,"hasMobilePhone":true,"hasSupplementalEmail":true,"jobTitle":"Chief Technology Officer","lastName":"Popovic","lastUpdatedDate":"2025-04-04T18:13:00Z","mobilePhoneDoNotCall":false,"validDate":"2024-11-14T22:29:00Z"},"id":"4191419698","type":"Contact"}],"links":{"first":"/data/v1/contacts/search?page[number]=1&page[size]=25","last":"/data/v1/contacts/search?page[number]=1&page[size]=25"},"meta":{"page":{"number":1,"total":1},"totalResults":1}}},"Contact search by personId":{"summary":"Contact search by personId","description":"This example demonstrates how to search for contacts using the ZoomInfo API utilizing single field. In this example, the personId field is used to find a matching contact.","value":{"data":[{"attributes":{"company":{"id":344589814,"name":"ZoomInfo"},"contactAccuracyScore":94,"directPhoneDoNotCall":false,"firstName":"Henry","hasCompanyCountry":true,"hasCompanyEmployeeCount":true,"hasCompanyIndustry":true,"hasCompanyPhone":true,"hasCompanyRevenue":true,"hasCompanyState":true,"hasCompanyStreet":true,"hasCompanyZipCode":true,"hasDirectPhone":true,"hasEmail":true,"hasMobilePhone":false,"hasSupplementalEmail":true,"jobTitle":"Chief Executive Officer & Board Member","lastName":"Schuck","lastUpdatedDate":"2024-10-21T14:05:00Z","middleName":"L.","mobilePhoneDoNotCall":false,"validDate":"2024-11-14T22:29:00Z"},"id":"1260398587","type":"Contact"}],"links":{"first":"/data/v1/contacts/search?page[number]=1&page[size]=25","last":"/data/v1/contacts/search?page[number]=1&page[size]=25"},"meta":{"page":{"number":1,"total":1},"totalResults":1}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Search"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ContactSearchRequest"},"examples":{"Contact search by companyName, firstName, and lastName":{"summary":"Contact search by companyName, firstName, and lastName","description":"This example demonstrates how to search for contacts using the ZoomInfo API utilizing multiple input fields. In this example, the companyName, firstName, and lastName fields are used to find a list of matching contacts.","value":{"data":{"attributes":{"companyName":"ZoomInfo","firstName":"Filip","lastName":"Popovic"},"type":"ContactSearch"}}},"Contact search by personId":{"summary":"Contact search by personId","description":"This example demonstrates how to search for contacts using the ZoomInfo API utilizing single field. In this example, the personId field is used to find a matching contact.","value":{"data":{"attributes":{"personId":"1260398587"},"type":"ContactSearch"}}}}}},"description":"The request body containing contact search criteria."},"security":[{"OAuth2Auth":["api:data:contact"]}],"x-additional-content-types":["application/json"],"x-api-roles":["fea:zia","fea:api"],"x-api-role-requirement":"ANY_REQUIRED"}},"/data/v1/companies/search":{"post":{"operationId":"SearchInterface_searchCompany","summary":"Search Companies","description":"Returns a list of Companies from ZoomInfo's data that meet the specified search criteria.\n\nInput parameters may require specific values. You can use the [Lookup Data](ref:lookupinterface_lookup)\nendpoint to retrieve the list of possible values\n\nThe Search Companies API only returns basic information about the company: including name, limited location details,\nwebsite, and few other basic data points. To get the additional data for companies in your results use the\n[Enrich Company API](ref:enrichinterface_enrichcompany)\n\nWith reference to ZoomInfo's [Credit Usage and Limits](doc:credit-usage-and-limits), this endpoint does not\nconsume any credits nor do copmanies returned count towards record limits, but each request will increment against your\nrequest limits.","parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page of results that you want to retrieve. If not provided, the first page\nof results will be returned. Use in connection with `page[size]` to handle large result sets.\n\nExample: `page[number]=2&page[size]=25` will return the second page of result (results 26-50 based\non the `sort` value).","schema":{"type":"integer","format":"int32","minimum":1},"explode":false},{"name":"page[size]","in":"query","required":false,"description":"Sets the number of records to return per page. If not provided, the default is 25 records per\npage. Valid values for page size are any integer from 1 to 100.","schema":{"type":"integer","format":"int32","minimum":1,"maximum":100},"explode":false},{"name":"sort","in":"query","required":false,"description":"Sort results by the specified output field. Valid values are name, employeeCount, and revenue. \nAdd minus sign ('-') for descending order. The default sort if not provided is to sort the results \nby revenue in descending order `-revenue`\n\nExamples:\n- `name` will sort results by company name in ascending alphabetical order.\n- `-employeeCount` will sort results in descending order (from company with the most number of employees\nto the company with the least number of employees)","schema":{"type":"string"},"explode":false}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CompanySearchResponse"},"examples":{"Company search by companyName for privileged customer":{"summary":"Company search by companyName for privileged customer","description":"This example demonstrates how to search for companies using the ZoomInfo API utilizing input field. In this example, the companyName field is used to find a list of matching companies.","value":{"data":[{"attributes":{"logo":"https://res.cloudinary.com/zoominfo-com/image/upload/w_100,h_100,c_fit/zoominfo.com","name":"ZoomInfo","website":"www.zoominfo.com"},"id":"344589814","type":"Company"},{"attributes":{"name":"Zoominfo Com C Peter Taflan Marketing Communications"},"id":"1307620605","type":"Company"}],"links":{"first":"/data/v1/companies/search?page#[number]=1&page#[size]=25","last":"/data/v1/companies/search?page#[number]=1&page#[size]=25"},"meta":{"page":{"number":1,"total":2},"totalResults":2}}},"Company search by metro region, industry codes including pagination and sorting url params":{"summary":"Company search by metro region, industry codes including pagination and sorting url params","description":"This example demonstrates how to search for companies using the ZoomInfo API utilizing multiple input fields. In this example, the metroRegion and industryCodes field is used to find a list of matching companies on second page with two records per page sorted by name ascending.","value":{"data":[{"attributes":{"name":"123cd.org"},"id":"57295081","type":"Company"},{"attributes":{"name":"12Kerala"},"id":"352306193","type":"Company"}],"links":{"first":"uri=/data/v1/companies/search?page[number]=1&page[size]=2","last":"uri=/data/v1/companies/search?page[number]=1426&page[size]=2","next":"uri=/data/v1/companies/search?page[number]=4&page[size]=2","prev":"uri=/data/v1/companies/search?page[number]=2&page[size]=2"},"meta":{"page":{"number":2,"total":2},"totalResults":2845}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Search"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CompanySearchRequest"},"examples":{"Company search by companyName for privileged customer":{"summary":"Company search by companyName for privileged customer","description":"This example demonstrates how to search for companies using the ZoomInfo API utilizing input field. In this example, the companyName field is used to find a list of matching companies.","value":{"data":{"attributes":{"companyName":"Zoominfo"},"type":"CompanySearch"}}},"Company search by metro region, industry codes including pagination and sorting url params":{"summary":"Company search by metro region, industry codes including pagination and sorting url params","description":"This example demonstrates how to search for companies using the ZoomInfo API utilizing multiple input fields. In this example, the metroRegion and industryCodes field is used to find a list of matching companies on second page with two records per page sorted by name ascending.","value":{"data":{"attributes":{"metroRegion":"usa.california.sanfrancisco","industryCodes":"education.university"},"type":"CompanySearch"}}}}}},"description":"The request body containing company search criteria."},"security":[{"OAuth2Auth":["api:data:company"]}],"x-additional-content-types":["application/json"],"x-api-roles":["fea:zia","fea:api"],"x-api-role-requirement":"ANY_REQUIRED"}},"/data/v1/intent/search":{"post":{"operationId":"SearchInterface_searchIntent","summary":"Search Intent","description":"Returns a list of Intent Signals from ZoomInfo's data that meet the specified search criteria. It is required \nthat every request include at least 1 and up to 50 intent topics in the request.\n\nIntent data is online behavior-based activity across the internet that links prospective buyers (companies) to a topic.\nIntent Signals are the way ZoomInfo tracks intent data and can be used to indicate recent content consumption for a specific\ntopic by employees at a company. Key terminology for Intent Signals includes:\n\n* **Topic** - A business subject or technology area mapped to a curated collection of keywords and search terms. \nWhen companies research content containing these keywords, it generates intent signals that indicate their buying interest\n* **Signal Score** - Indicates the level of a company's interest in a topic based on how recent content consumption \ncompares to an historical baseline\n* **Audience Strength** - Indicates the size of the group at the company that is conducting the research\n\nUse Search Intent to find Intent Signals across all ZoomInfo companies. To find Intent Signals for a specific company, use the\n[Enrich Intent](ref:enrichinterface_enrichintent) endpoint.\n\nInput parameters may require specific values. You can use the [Lookup Data](ref:lookupinterface_lookup)\nendpoint to retrieve the list of possible values.\n\nWith reference to ZoomInfo's [Credit Usage and Limits](doc:credit-usage-and-limits), this endpoint does not\nconsume any credits, but each Intent Signal returned in the results is counted as a Record and a successful response\nwill count as a Request credit.","parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page of results that you want to retrieve. If not provided, the first page\nof results will be returned. Use in connection with `page[size]` to handle large result sets.\n\nExample: `page[number]=2&page[size]=25` will return the second page of result (results 26-50 based\non the `sort` value).","schema":{"type":"integer","format":"int32","minimum":1},"explode":false},{"name":"page[size]","in":"query","required":false,"description":"Sets the number of records to return per page. If not provided, the default is 25 records per\npage. Valid values for page size are any integer from 1 to 100.","schema":{"type":"integer","format":"int32","minimum":1,"maximum":100},"explode":false},{"name":"sort","in":"query","required":false,"description":"Sort results by the specified output field. Valid values are `signalDate`, `companyName`, `signalScore`,\n`category`, `topic`, and `audienceStrength`. Add minus sign ('-') for descending order. The default,\nif not provided, is to sort the results by `topic` name in descending order (`-topic`)\n\nExamples:\n- `companyName` will sort results by company name in ascending alphabetical order.\n- `-signalDate` will sort results in descending order by signal date (from most recent signals to\nthe oldest signals)","schema":{"type":"string"},"explode":false}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/IntentSearchResponse"},"examples":{"Intent search by various attributes":{"summary":"Intent search by various attributes","description":"This example demonstrates how to search for intent topics using the ZoomInfo API utilizing input fields.","value":{"data":[{"attributes":{"audienceStrength":"B","category":"Cloud","recommendedContacts":[{"id":"4191419698","firstName":"Filip","lastName":"Popovic","jobTitle":"Chief Technology Officer","companyName":"ZoomInfo"},{"id":"1260398587","firstName":"John","lastName":"Doe","jobTitle":"Software Engineer","companyName":"TechCorp"}],"signalDate":"2025-05-24T00:00:00Z","signalScore":82,"spikesInDateRange":1,"topic":"Cloud Applications"},"id":"vopctz9gg4g8#47028048#20250524","type":"Intent"}],"links":{"first":"/data/v1/intents/search?page#[number]=1&page#[size]=25","last":"/data/v1/intents/search?page#[number]=1&page#[size]=25"},"meta":{"page":{"number":1,"total":1},"totalResults":1}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Search"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/IntentSearchRequest"},"examples":{"Intent search by various attributes":{"summary":"Intent search by various attributes","description":"This example demonstrates how to search for intent topics using the ZoomInfo API utilizing input fields.","value":{"data":{"attributes":{"topics":["Cloud Applications"],"signalScoreMin":80,"signalScoreMax":100,"audienceStrengthMin":"C","audienceStrengthMax":"A","metroRegion":"usa.california.sanfrancisco","industryCodes":"education.university"},"type":"IntentSearch"}}}}}},"description":"The request body containing intent search criteria."},"security":[{"OAuth2Auth":["api:data:intent"]}],"x-additional-content-types":["application/json"],"x-api-roles":["fea:zia","fea:api"],"x-api-role-requirement":"ANY_REQUIRED"}},"/data/v1/news/search":{"post":{"operationId":"SearchInterface_searchNews","summary":"Search News","description":"Returns a list of News articles from ZoomInfo's data that meet the specified search criteria. All inputs are optional,\nbut at least one input must be set to get a successful response.\n\nInput parameters may require specific values. You can use the [Lookup Data](ref:lookupinterface_lookup)\nendpoint to retrieve the list of possible values.\n\nUse Search News to find News articles across all ZoomInfo companies, if you want to get News articles for a specific ZoomInfo company,\nuse the [Enrich News](ref:enrichinterface_enrichnews) endpoint.\n\nWith reference to ZoomInfo's [Credit Usage and Limits](doc:credit-usage-and-limits), this endpoint does not\nconsume any Credits. Each News article returned in the results does count towards the customer's Record Limit\nand a successful response will count towards the Request Limit (e.g. for a response that returns 10 news articles, 10 Records will\nbe counted and 1 Request will be counted)","parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page of results that you want to retrieve. If not provided, the first page\nof results will be returned. Use in connection with `page[size]` to handle large result sets.\n\nExample: `page[number]=2&page[size]=25` will return the second page of result (results 26-50 based\non the `sort` value).","schema":{"type":"integer","format":"int32","minimum":1},"explode":false},{"name":"page[size]","in":"query","required":false,"description":"Sets the number of records to return per page. If not provided, the default is 25 records per\npage. Valid values for page size are any integer from 1 to 100.","schema":{"type":"integer","format":"int32","minimum":1,"maximum":100},"explode":false}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/NewsSearchResponse"},"examples":{"Search news articles by category and publish date":{"summary":"Search news articles by category and publish date","description":"This example demonstrates how to search for news articles using the ZoomInfo API utilizing categories, pageDateMin and pageDateMax. In this example, the categories field is used to filter articles related to specific topics such as 'PRODUCT' and 'PERSON', and the publish date range is set from January 1, 2024, to December 31, 2024. The response includes articles that match these criteria, with pagination enabled to retrieve results in chunks of two articles per page.","value":{"data":[{"type":"News","id":"article-1","attributes":{"domain":"techcrunch.com","title":"ZoomInfo Launches New AI Product","url":"https://www.techcrunch.com/articles/zoominfo-launch-ai-product","imageUrl":"https://www.techcrunch.com/images/zoominfo-launch.jpg","pageDate":"2024-05-20T14:00:00Z","categories":["PRODUCT"],"description":"ZoomInfo has launched a new AI-driven product to enhance go-to-market strategies.","company":[{"id":344589814,"name":"ZoomInfo"}]}},{"type":"News","id":"article-2","attributes":{"domain":"businesswire.com","title":"ZoomInfo Appoints New CTO","url":"https://www.businesswire.com/news/zoominfo-new-cto","imageUrl":"https://www.businesswire.com/images/cto-hire.jpg","pageDate":"2024-03-12T09:30:00Z","categories":["PERSON"],"description":"ZoomInfo has appointed Jane Doe as its new Chief Technology Officer.","company":[{"id":344589814,"name":"ZoomInfo"}]}}],"meta":{"page":{"number":1,"total":1},"totalResults":2},"links":{"first":"/data/v1/news/search?page[number]=1&page[size]=2","last":"/data/v1/news/search?page[number]=1&page[size]=2"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Search"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/NewsSearchRequest"},"examples":{"Search news articles by category and publish date":{"summary":"Search news articles by category and publish date","description":"This example demonstrates how to search for news articles using the ZoomInfo API utilizing categories, pageDateMin and pageDateMax. In this example, the categories field is used to filter articles related to specific topics such as 'PRODUCT' and 'PERSON', and the publish date range is set from January 1, 2024, to December 31, 2024. The response includes articles that match these criteria, with pagination enabled to retrieve results in chunks of two articles per page.","value":{"data":{"type":"NewsSearch","attributes":{"categories":["PRODUCT","PERSON"],"pageDateMin":"2024-01-01","pageDateMax":"2024-12-31"}}}}}}},"description":"The request body containing news search criteria."},"security":[{"OAuth2Auth":["api:data:news"]}],"x-additional-content-types":["application/json"],"x-api-roles":["fea:zia","fea:api"],"x-api-role-requirement":"ANY_REQUIRED"}},"/data/v1/scoops/search":{"post":{"operationId":"SearchInterface_searchScoop","summary":"Search Scoops","description":"Returns a list of Scoops from ZoomInfo's data that meet the specified search criteria. \n\nScoops are real-time business intelligence signals that provide timely insights into significant events \nand changes occurring at companies. These actionable data points help sales and marketing teams identify \nopportunities and engage prospects at the right moment.\n\nInput parameters may require specific values. You can use the [Lookup Data](ref:lookupinterface_lookup)\nendpoint to retrieve the list of possible values.\n\nUse Search Scoops to find Scoops across all ZoomInfo companies, if you want to get Scoops for a specific ZoomInfo company,\nuse the [Enrich Scoops](ref:enrichinterface_enrichscoop) endpoint.\n\nWith reference to ZoomInfo's [Credit Usage and Limits](doc:credit-usage-and-limits), this endpoint does not\nconsume any Credits. Each Scoop returned in the results does count towards the customer's Record Limit\nand a successful response will count towards the Request Limit (e.g. for a response that returns 10 Scoops, 10 Records will\nbe counted and 1 Request will be counted)","parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page of results that you want to retrieve. If not provided, the first page\nof results will be returned. Use in connection with `page[size]` to handle large result sets.\n\nExample: `page[number]=2&page[size]=25` will return the second page of result (results 26-50 based\non the `sort` value).","schema":{"type":"integer","format":"int32","minimum":1},"explode":false},{"name":"page[size]","in":"query","required":false,"description":"Sets the number of records to return per page. If not provided, the default is 25 records per\npage. Valid values for page size are any integer from 1 to 100.","schema":{"type":"integer","format":"int32","minimum":1,"maximum":100},"explode":false},{"name":"sort","in":"query","required":false,"description":"Sort results by the specified output field. Valid values are `scoopId`, `originalPublishedDate`, `description`,\n`link`, and `linkText`. Add minus sign ('-') for descending order. The default, if not provided, is to sort the\nresults by `originalPublishedDate` in descending order (`-originalPublishedDate`)\n\nExamples:\n- `scoopId` will sort results by Scoop id in ascending alphabetical order.\n- `-description` will sort results in reverse alphabetical order by the Scoop description","schema":{"type":"string"},"explode":false}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ScoopSearchResponse"},"examples":{"Search scoops by company name and scoop type":{"summary":"Search scoops by company name and scoop type","description":"This example demonstrates how to search for scoops using the ZoomInfo API by filtering on company name and scoop type. In this example, we search for ZoomInfo company scoops with scoop type '6' (Award type), within a date range from November 1, 2018, to March 1, 2019. The response returns 3 award-related scoops, each containing company information, descriptions, publication dates, and associated topics and types metadata.","value":{"data":[{"type":"Scoop","id":"1382057","attributes":{"id":"1382057","company":{"id":"344589814","name":"ZoomInfo"},"description":"ZoomInfo Datanyze has recently been ranked #986 on the 2019 SaaS 1000 Top SaaS Companies list.","originalPublishedDate":"2019-02-22T00:00:00Z","publishedDate":"2019-02-22T00:00:00Z","types":[{"id":"6","type":"Award"}]}},{"type":"Scoop","id":"1382056","attributes":{"id":"1382056","company":{"id":"344589814","name":"ZoomInfo"},"description":"ZoomInfo has recently been ranked #139 on the 2019 SaaS 1000 Top SaaS Companies list.","originalPublishedDate":"2019-02-15T00:00:00Z","publishedDate":"2019-02-15T00:00:00Z","topics":[{"id":"5","topic":"Award"}],"types":[{"id":"6","type":"Award"}]}},{"type":"Scoop","id":"1373240","attributes":{"id":"1373240","company":{"id":"344589814","name":"ZoomInfo"},"description":"ZoomInfo has been recognized as a 2019 Top Rated Sales Intelligence Software by TrustRadius.","originalPublishedDate":"2019-02-11T00:00:00Z","publishedDate":"2019-02-11T00:00:00Z","topics":[{"id":"5","topic":"Award"}],"types":[{"id":"6","type":"Award"}]}}],"links":{"first":"uri=/data/v1/scoops/search?page[number]=1&page[size]=25","last":"uri=/data/v1/scoops/search?page[number]=1&page[size]=25"},"meta":{"page":{"number":1,"total":3},"totalResults":3}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Search"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ScoopSearchRequest"},"examples":{"Search scoops by company name and scoop type":{"summary":"Search scoops by company name and scoop type","description":"This example demonstrates how to search for scoops using the ZoomInfo API by filtering on company name and scoop type. In this example, we search for ZoomInfo company scoops with scoop type '6' (Award type), within a date range from November 1, 2018, to March 1, 2019. The response returns 3 award-related scoops, each containing company information, descriptions, publication dates, and associated topics and types metadata.","value":{"data":{"type":"ScoopSearch","attributes":{"scoopType":"6","updatedSinceCreation":false,"publishedStartDate":"2018-11-01","publishedEndDate":"2019-03-01"}}}}}}},"description":"The request body containing scoop search criteria."},"security":[{"OAuth2Auth":["api:data:scoops"]}],"x-additional-content-types":["application/json"],"x-api-roles":["fea:zia","fea:api"],"x-api-role-requirement":"ANY_REQUIRED"}},"/data/v1/contacts/enrich":{"post":{"operationId":"EnrichInterface_enrichContact","summary":"Enrich Contacts","description":"Enrich Contacts can be used to retrieve detailed information about up to 25 individual contact records.\nBest practice is to first use the [Search Contacts](ref:searchinterface_searchcontact) to identify the records \nyou want to enrich, and then use the Contact IDs as the input to specify the correct records. If your workflow does not \nsupport a two stage retrieval using both Search and Enrich endpoints, you can query the Contact Enrich Endpoint with more \nextensive input information and our system will provide the best match available to the input. The more details you provide \nthe more likely we are to provide the correct match. \n\nOnce you have indicated which records you want to enrich, you must then select which fields you want to return for the \nrecords using the `outputFields` list. For more details about all of the available output fields you can select, please \nuse the [Lookup Enrich](ref:lookupenrichinterface_lookupenrich) endpoint (`filter[entity]=contact` and `filter[fieldType]=output`). \nThis will provide a description of each available field, as well as whether or not your account has access to this field. \nIf you do not have access to a field that you need, please contact your ZoomInfo Account Manager for purchasing options. \n\nYou can also use the `requiredFields` list to indicate which fields must be available for output in order to return\na record. For example, if you include `jobTitle` in `requiredFields` we will not return a contact for which we do not \nhave a job title recorded, even if it is a perfect match for the input criteria you provided. \n\nEach record returned by this endpoint will charge a credit from your account, unless that record is already under management \n(see [Credit Usage and Limits Guide](doc:credit-usage-and-limits) for more details). If we fail to find the record and return \n“No match” or if we return an error code a credit will not be charged.","parameters":[],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ContactEnrichResponse"},"examples":{"Enrich Contact by Person ID Using Output Fields and Required Fields for a Full Match":{"summary":"Enrich Contact by Person ID Using Output Fields and Required Fields for a Full Match","description":"This example demonstrates how to enrich a single contact using a unique personId. The request specifies a set of outputFields to return, including email, company name, and movement status, while ensuring that required fields like id and company name are always included. This allows for precise and efficient contact data retrieval. Up to 25 contacts can be enriched in a single request.","value":{"data":[{"attributes":{"company":{"id":346572700,"name":"ZoomInfo"},"email":"henry@zoominfo.com","hasCanadianEmail":false,"personHasMoved":"No"},"id":"344589814","meta":{"input":{"personId":4191419698},"matchStatus":"FULL_MATCH"},"type":"Contact"}]}},"Enrich Contact by Person ID Using Various Company Output Fields and Required Fields for a Full Match":{"summary":"Enrich Contact by Person ID Using Various Company Output Fields and Required Fields for a Full Match","description":"This example demonstrates how to enrich a single contact using a unique personId. The request specifies a set of outputFields related to the contact's company to return, including company name, company logo, and company revenue, while ensuring that required fields like id and company name are always included.","value":{"data":[{"attributes":{"company":{"city":"Vancouver","country":"United States","description":"ZoomInfo is the go-to-market platform that helps businesses find, acquire, and grow customers. ZoomInfo is the most comprehensive source of business information on people and companies in the world. ZoomInfo is used by sales and marketing professionals to find leads, recruiters to uncover talent and by business professionals to find detailed information on people and companies.","employeeCount":3508,"employeeRange":"1,000 - 5,000","fax":"(617) 507-8187","id":344589814,"industries":["Software","Business Intelligence (BI) Software"],"logo":"https://res.cloudinary.com/zoominfo-com/image/upload/w_100,h_100,c_fit/zoominfo.com","naicsCodes":[{"id":"51","name":"Information"},{"id":"516","name":"Broadcasting and Content Providers"},{"id":"5162","name":"Media Streaming Distribution Services, Social Networks, and Other Media Networks and Content Providers"},{"id":"51621","name":"Media Streaming Distribution Services, Social Networks, and Other Media Networks and Content Providers"},{"id":"517","name":"Telecommunications"},{"id":"5171","name":"Wired and Wireless Telecommunications (except Satellite)"},{"id":"51711","name":"Wired and Wireless Telecommunications Carriers (except Satellite)"},{"id":"54","name":"Professional, Scientific, and Technical Services"},{"id":"541","name":"Professional, Scientific, and Technical Services"},{"id":"5415","name":"Computer Systems Design and Related Services"},{"id":"54151","name":"Computer Systems Design and Related Services"},{"id":"541511","name":"Custom Computer Programming Services"},{"id":"511","name":"Publishing Industries (except Internet)"},{"id":"5112","name":"Software Publishers"},{"id":"51121","name":"Software Publishers"},{"id":"511210","name":"Software Publishers"}],"name":"ZoomInfo","phone":"(866) 904-9666","primaryIndustry":["Software","Business Intelligence (BI) Software"],"revenue":"$1.2 Billion","revenueNumeric":1214300000,"revenueRange":"$1 bil. - $5 bil.","sicCodes":[{"id":"73","name":"Business Services"},{"id":"737","name":"Computer Programming, Data Processing, And Other Computer Related Services"},{"id":"7372","name":"Prepackaged Software"},{"id":"738","name":"Miscellaneous Business Services"},{"id":"7389","name":"Business Services, Not Elsewhere Classified"},{"id":"7371","name":"Computer Programming Services"}],"socialMediaUrls":[{"followerCount":"128080","type":"LINKED_IN","url":"http://www.linkedin.com/company/zoominfo"},{"followerCount":"14415","type":"TWITTER","url":"http://www.twitter.com/zoominfo"},{"type":"FACEBOOK","url":"http://www.facebook.com/109325735758217"}],"state":"Washington","street":"805 Broadway St Ste 900","ticker":"NASDAQ:GTM","type":"PUBLIC","website":"www.zoominfo.com","zipCode":"98660"},"email":"henry@zoominfo.com","hasCanadianEmail":false,"personHasMoved":"No"},"id":"344589814","meta":{"input":{"personId":4191419698},"matchStatus":"FULL_MATCH"},"type":"Contact"}]}},"Enrich Multiple Contacts Using Required Fields and Output Fields for a Full Match.":{"summary":"Enrich Multiple Contacts Using Required Fields and Output Fields for a Full Match.","description":"This example demonstrates how to enrich multiple contacts by using a mix of identifiers—including a combination of firstName, lastName, and companyName, as well as a direct personId. The request specifies a wide range of outputFields, such as email, job title, address, company details, and regulatory flags. This allows for detailed enrichment of each contact. The response returns enriched data for each matched contact, and up to 25 contacts can be processed in a single request.","value":{"data":[{"attributes":{"company":{"id":346572700,"name":"ZoomInfo","employeeCount":3508,"primaryIndustry":["Software","Business Intelligence Software"]},"country":"United States","email":"henry@zoominfo.com","hasCanadianEmail":false,"jobTitle":"Chief Executive Officer & Board Member","directPhoneDoNotCall":false,"directPhoneAlt":[{"value":"+1-360-555-1234","source":"waterfall"}],"mobilePhoneAlt":[{"value":"+1-360-555-5678","source":"waterfall"}],"emailAlt":[{"value":"henry.schuck@zoominfo.com","source":"waterfall"}],"withinCalifornia":false,"withinCanada":false,"withinEu":false,"metroArea":"Boston","personHasMoved":"No","region":"Massachusetts","state":"Massachusetts","street":"404 Wyman St","zipCode":"02451"},"id":"344589814","meta":{"input":{"companyName":"zoominfo","firstName":"henry","lastName":"schuck"},"matchStatus":"FULL_MATCH"},"type":"Contact"},{"attributes":{"city":"Bethesda","company":{"id":346572700,"name":"ZoomInfo","employeeCount":3508,"primaryIndustry":["Software","Business Intelligence Software"]},"country":"United States","directPhoneDoNotCall":false,"email":"filip@discoverorg.com","firstName":"Filip","hasCanadianEmail":false,"jobTitle":"Chief Technology Officer","managementLevel":["C-Level"],"metroArea":"Washington","personHasMoved":"Uncertain","region":"Maryland","state":"Maryland","street":"7700 Old Georgetown Rd 5th Fl","zipCode":"20814"},"id":"234343645","meta":{"input":{"personId":4191419698},"matchStatus":"FULL_MATCH"},"type":"Contact"}]}},"Enrich Contact by Person ID Using Output Fields for a No Match":{"summary":"Enrich Contact by Person ID Using Output Fields for a No Match","description":"This example demonstrates how to enrich a single contact using a unique personId. The request specifies a set of outputFields to return, including email, company name, and movement status. The response is a no match response for the contact criteria requested.","value":{"data":[{"id":"0","meta":{"input":{"personId":0},"matchStatus":"NO_MATCH"},"type":"NoMatch"}]}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Enrich"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ContactEnrichRequest"},"examples":{"Enrich Contact by Person ID Using Output Fields and Required Fields for a Full Match":{"summary":"Enrich Contact by Person ID Using Output Fields and Required Fields for a Full Match","description":"This example demonstrates how to enrich a single contact using a unique personId. The request specifies a set of outputFields to return, including email, company name, and movement status, while ensuring that required fields like id and company name are always included. This allows for precise and efficient contact data retrieval. Up to 25 contacts can be enriched in a single request.","value":{"data":{"attributes":{"matchPersonInput":[{"personId":4191419698}],"outputFields":["id","email","personHasMoved","hasCanadianEmail","companyName"],"requiredFields":["id","companyName"]},"type":"ContactEnrich"}}},"Enrich Contact by Person ID Using Various Company Output Fields and Required Fields for a Full Match":{"summary":"Enrich Contact by Person ID Using Various Company Output Fields and Required Fields for a Full Match","description":"This example demonstrates how to enrich a single contact using a unique personId. The request specifies a set of outputFields related to the contact's company to return, including company name, company logo, and company revenue, while ensuring that required fields like id and company name are always included.","value":{"data":{"attributes":{"matchPersonInput":[{"personId":4191419698}],"outputFields":["id","email","personHasMoved","companyName","companyDescriptionList","companyPhone","companyFax","companyStreet","companyCity","companyState","companyZipCode","companyCountry","companyLogo","companySicCodes","companyNaicsCodes","contactAccuracyScore","companyWebsite","companyRevenue","companyRevenueNumeric","companyEmployeeCount","companyType","companyTicker","companyRanking","companySocialMediaUrls","companyPrimaryIndustry","companyIndustries","companyRevenueRange","companyEmployeeRange"],"requiredFields":["id","companyName"]},"type":"ContactEnrich"}}},"Enrich Multiple Contacts Using Required Fields and Output Fields for a Full Match.":{"summary":"Enrich Multiple Contacts Using Required Fields and Output Fields for a Full Match.","description":"This example demonstrates how to enrich multiple contacts by using a mix of identifiers—including a combination of firstName, lastName, and companyName, as well as a direct personId. The request specifies a wide range of outputFields, such as email, job title, address, company details, and regulatory flags. This allows for detailed enrichment of each contact. The response returns enriched data for each matched contact, and up to 25 contacts can be processed in a single request.","value":{"data":{"attributes":{"matchPersonInput":[{"firstName":"henry","companyName":"zoominfo","lastName":"schuck"},{"personId":4191419698}],"outputFields":["id","email","personHasMoved","hasCanadianEmail","region","jobTitle","companyName","companyId","managementLevel","companyPrimaryIndustry","companyEmployeeCount","street","city","region","metroArea","zipCode","state","country","directPhoneDoNotCall","directPhoneAlt","mobilePhoneAlt","emailAlt"],"requiredFields":["id","companyName"]},"type":"ContactEnrich"}}},"Enrich Contact by Person ID Using Output Fields for a No Match":{"summary":"Enrich Contact by Person ID Using Output Fields for a No Match","description":"This example demonstrates how to enrich a single contact using a unique personId. The request specifies a set of outputFields to return, including email, company name, and movement status. The response is a no match response for the contact criteria requested.","value":{"data":{"attributes":{"matchPersonInput":[{"personId":0}],"outputFields":["id","email","personHasMoved","hasCanadianEmail","companyName"]},"type":"ContactEnrich"}}}}}},"description":"The request body containing contact enrich criteria."},"security":[{"OAuth2Auth":["api:data:contact"]}],"x-additional-content-types":["application/json"],"x-api-roles":["fea:zia","fea:api"],"x-api-role-requirement":"ANY_REQUIRED"}},"/data/v1/companies/enrich":{"post":{"operationId":"EnrichInterface_enrichCompany","summary":"Enrich Companies","description":"The Enrich Companies endpoint can be used to retrieve detailed information about up to 25 individual company records. \nBest practice is to first use [Search Companies](ref:searchinterface_searchcompany) to identify the records \nyou want to enrich, and then use the Company IDs as the input to specify the correct records. If your workflow does not \nsupport a two stage retrieval using both Search and Enrich endpoints, you can query the Company Enrich endpoint with more \nextensive input information and our system will provide the best match available to the input. The more details you provide \nthe more likely we are to provide the correct match. \n\nOnce you have indicated which records you want to enrich, you must then select which fields you want to return for the \nrecords using the `outputFields` list. For more details about all of the available output fields you can select, please \nuse the [Lookup Enrich](ref:lookupenrichinterface_lookupenrich) endpoint (`filter[entity]=company` and `filter[fieldType]=output`). \nThis will provide a description of each available field, as well as whether or not your account has access to this field. \nIf you do not have access to a field that you need, please contact your ZoomInfo Account Manager for purchasing options. \n\nEach record returned by this endpoint will charge a credit from your account, unless that record is already under management \n(see [Credit Usage and Limits Guide](doc:credit-usage-and-limits) for more details). If we fail to find the record and return \n“No match” or if we return an error code a credit will not be charged.","parameters":[],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CompanyEnrichResponse"},"examples":{"Enrich Company Data by Website Using Multiple Output Fields for a Full Match":{"summary":"Enrich Company Data by Website Using Multiple Output Fields for a Full Match","description":"This example demonstrates how to enrich company data using a companyWebsite input and specifying a list of outputFields for the API to return. The response includes the number of matching records. You can include up to 25 company inputs in a single enrich request.","value":{"data":[{"attributes":{"name":"ZoomInfo","socialMediaUrls":[{"followerCount":"128080","type":"LINKED_IN","url":"http://www.linkedin.com/company/zoominfo"},{"followerCount":"14413","type":"TWITTER","url":"http://www.twitter.com/zoominfo"},{"type":"FACEBOOK","url":"http://www.facebook.com/109325735758217"}],"ticker":"NASDAQ: GTM","website":"www.zoominfo.com"},"id":"344589814","meta":{"input":{"companyWebsite":"www.zoominfo.com"},"matchStatus":"FULL_MATCH"},"type":"Company"}]}},"Enrich Company Data Using Multiple Inputs and Output Fields for a Full Match":{"summary":"Enrich Company Data Using Multiple Inputs and Output Fields for a Full Match","description":"This example demonstrates how to enrich multiple companies by providing company details such as companyId and set of outputFields is specified to retrieve detailed company attributes, including website, revenue, social media presence, employee range, parent company details, and more. The response returns enriched data for each matched company. Up to 25 companies can be included in a single enrich request.","value":{"data":[{"attributes":{"certified":true,"companyStatus":"ALIVE","continent":"North America","country":"United States","employeeRange":"1,000 - 5,000","foundedYear":"2000","locationCount":18,"name":"ZoomInfo","numberOfContactsInZoomInfo":4336,"parentId":0,"revenue":245188088,"socialMediaUrls":[{"followerCount":"128080","type":"LINKED_IN","url":"http://www.linkedin.com/company/zoominfo"},{"followerCount":"14413","type":"TWITTER","url":"http://www.twitter.com/zoominfo"},{"type":"FACEBOOK","url":"http://www.facebook.com/109325735758217"}],"ticker":"NASDAQ: GTM","website":"www.zoominfo.com"},"id":"344589814","meta":{"input":{"companyId":344589814},"matchStatus":"FULL_MATCH"},"type":"Company"},{"attributes":{"certified":true,"companyStatus":"ALIVE","continent":"North America","country":"United States","employeeRange":"50 -100","foundedYear":"2015","locationCount":2,"name":"Comparably","numberOfContactsInZoomInfo":55,"parentId":344589814,"parentName":"ZoomInfo Technologies LLC","revenue":11615,"socialMediaUrls":[{"followerCount":"19537","type":"TWITTER","url":"http://www.twitter.com/comparably"},{"followerCount":"14413","type":"LINKED_IN","url":"http://www.linkedin.com/company/comparably"},{"followerCount":"6436","type":"FACEBOOK","url":"http://www.facebook.com/comparably"}],"website":"www.comparably.com"},"id":"344589814","meta":{"input":{"companyId":344589814},"matchStatus":"FULL_MATCH"},"type":"Company"}]}},"Enrich Company Data by Website Using Multiple Output Fields resulting no Match":{"summary":"Enrich Company Data by Website Using Multiple Output Fields resulting no Match","description":"This example demonstrates how to enrich company data using a companyWebsite input and specifying a list of outputFields for the API to return. The response is a no match response for the company criteria requested.","value":{"data":[{"id":"0","meta":{"input":{"companyWebsite":"www.no-company.com"},"matchStatus":"NO_MATCH"},"type":"NoMatch"}]}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Enrich"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CompanyEnrichRequest"},"examples":{"Enrich Company Data by Website Using Multiple Output Fields for a Full Match":{"summary":"Enrich Company Data by Website Using Multiple Output Fields for a Full Match","description":"This example demonstrates how to enrich company data using a companyWebsite input and specifying a list of outputFields for the API to return. The response includes the number of matching records. You can include up to 25 company inputs in a single enrich request.","value":{"data":{"attributes":{"matchCompanyInput":[{"companyWebsite":"www.zoominfo.com"}],"outputFields":["id","ticker","name","website","socialMediaUrls"]},"type":"CompanyEnrich"}}},"Enrich Company Data Using Multiple Inputs and Output Fields for a Full Match":{"summary":"Enrich Company Data Using Multiple Inputs and Output Fields for a Full Match","description":"This example demonstrates how to enrich multiple companies by providing company details such as companyId and set of outputFields is specified to retrieve detailed company attributes, including website, revenue, social media presence, employee range, parent company details, and more. The response returns enriched data for each matched company. Up to 25 companies can be included in a single enrich request.","value":{"data":{"attributes":{"matchCompanyInput":[{"companyId":344589814},{"companyId":344589814}],"outputFields":["id","ticker","name","website","socialMediaUrls","revenue","numberOfContactsInZoomInfo","country","continent","companyStatus","alexaRank","hashtags","certified","employeeRange","employeeRange","employeeGrowth","parentId","parentName","locationCount","foundedYear"]},"type":"CompanyEnrich"}}},"Enrich Company Data by Website Using Multiple Output Fields resulting no Match":{"summary":"Enrich Company Data by Website Using Multiple Output Fields resulting no Match","description":"This example demonstrates how to enrich company data using a companyWebsite input and specifying a list of outputFields for the API to return. The response is a no match response for the company criteria requested.","value":{"data":{"attributes":{"matchCompanyInput":[{"companyWebsite":"www.no-company.com"}],"outputFields":["id","ticker","name","website","socialMediaUrls"]},"type":"CompanyEnrich"}}}}}},"description":"The request body containing company enrich criteria."},"security":[{"OAuth2Auth":["api:data:company"]}],"x-additional-content-types":["application/json"],"x-api-roles":["fea:zia","fea:api"],"x-api-role-requirement":"ANY_REQUIRED"}},"/data/v1/companies/corporate-hierarchy/enrich":{"post":{"operationId":"EnrichInterface_enrichCorporateHierarchy","summary":"Enrich Corporate Hierarchy","description":"Enrich the corporate hierarchy structure of up to 25 individual company records. Based on the provided inputs, \nZoomInfo will find the Company that best matches in provided inputs and return the full corporate hierarchy\nstructure for the matched Company. Corporate hierarchy structure includes the `familyTree` which starts at the \ntop-level parent company for the matched Company, and lists all Subsidiaries, Acquisitions, Former Names (if a company\nwithin the hierarchy has officially changed names previously). The `familyTree` also lists all known Locations for each \ncompany within the hierarchy. If no match can be made from the provided input values, then a `NoMatch` record is returned.\n\nAdditionally, if the company that was matched **IS NOT** the company at the top of the hierarchy structure, the `parentage` can\nbe provided in the response. This lists the all of the parent companies for the matched company all the way to the top-level\n(ultimate parent) company.\n\nThe desired `outputFields` must be provided for each request. For more details about all of the available output fields \nyou can select, please use the [Lookup Enrich](ref:lookupenrichinterface_lookupenrich) endpoint (`filter[entity]=corporate-hierarchy`\nand `filter[fieldType]=output`). This will provide a description of each available field, as well as whether or not your account has\naccess to this field.  If you do not have access to a field that you need, please contact your ZoomInfo Account Manager for purchasing options.\n\nEach record returned by this endpoint will charge a credit from your account, unless that record is already under management \n(see [Credit Usage and Limits Guide](doc:credit-usage-and-limits) for more details). If we fail to find the record and return \n`NoMatch` or if we return an error code a credit will not be charged.","parameters":[],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CorporateHierarchyEnrichResponse"},"examples":{"Enrich Corporate Hierarchy Data by Company ID":{"summary":"Enrich Corporate Hierarchy Data by Company ID","description":"This example demonstrates how to enrich corporate hierarchy data using a companyId input. The response includes the family tree showing ZoomInfo's subsidiaries with their organizational relationships.","value":{"data":[{"attributes":{"companyId":344589814,"familyTree":[{"companyId":344589814,"name":"ZoomInfo","city":"Vancouver","state":"Washington","familyNodes":[{"name":"Comparably","companyId":382321985,"city":"Santa Monica","state":"California","subUnitTypeInfo":{"typeId":4,"typeDescription":"Subsidiary"}},{"name":"DiscoverOrg","companyId":346572700,"city":"Vancouver","state":"Washington","subUnitTypeInfo":{"typeId":5,"typeDescription":"Acquisition"}}]}]},"id":"344589814","meta":{"input":{"companyId":344589814},"matchStatus":"FULL_MATCH"},"type":"CorporateHierarchy"}]}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Enrich"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CorporateHierarchyEnrichRequest"},"examples":{"Enrich Corporate Hierarchy Data by Company ID":{"summary":"Enrich Corporate Hierarchy Data by Company ID","description":"This example demonstrates how to enrich corporate hierarchy data using a companyId input. The response includes the family tree showing ZoomInfo's subsidiaries with their organizational relationships.","value":{"data":{"attributes":{"matchCompanyInput":[{"companyId":344589814}],"outputFields":["familyTree","companyId"]},"type":"CorporateHierarchyEnrich"}}}}}},"description":"The request body containing corporate hierarchy enrich criteria."},"security":[{"OAuth2Auth":["api:data:company"]}],"x-additional-content-types":["application/json"],"x-api-roles":["fea:zia","fea:api"],"x-api-role-requirement":"ANY_REQUIRED"}},"/data/v1/intent/enrich":{"post":{"operationId":"EnrichInterface_enrichIntent","summary":"Enrich Intent","description":"Fetch Intent Signals for a company, enriching that company's details with relevant buyer intent data. It is required\nfor each request to provide at least one of the parameters identifying the company to enrich (`companyId`, `companyName`, or \n`companyWebsite`) and at least 1 and up to 50 Intent Topics must be provided in the `topic` parameter. All other parameters\nare optional.\n\nIntent data is online behavior-based activity across the internet that links prospective buyers (companies) to a topic.\nIntent Signals are the way ZoomInfo tracks intent data and can be used to indicate recent content consumption for a specific\ntopic by employees at a company. Key terminology for Intent Signals includes:\n\n* **Topic** - A business subject or technology area mapped to a curated collection of keywords and search terms. \nWhen companies research content containing these keywords, it generates intent signals that indicate their buying interest\n* **Signal Score** - Indicates the level of a company's interest in a topic based on how recent content consumption \ncompares to an historical baseline\n* **Audience Strength** - Indicates the size of the group at the company that is conducting the research\n\nUse Enrich Intent to find Intent Signals for a single company. To search Intent Signals across all of the companies in\nthe ZoomInfo database use [Search Intent](ref:searchinterface_searchintent)\n\nInput parameters may require specific values. You can use the [Lookup Data](ref:lookupinterface_lookup)\nendpoint to retrieve the list of possible values.\n\nWith reference to ZoomInfo's [Credit Usage and Limits](doc:credit-usage-and-limits), this endpoint will charge a single credit\nfor the company that is enriched, and each Intent Signal returned in the results is counted as a Record and a successful response\nwill count as a Request credit.","parameters":[{"name":"page[number]","in":"query","required":false,"description":"Page number for the results.","schema":{"type":"integer","format":"int32","minimum":1},"explode":false},{"name":"page[size]","in":"query","required":false,"description":"Number of records to return per page. Default is 25.","schema":{"type":"integer","format":"int32","minimum":1,"maximum":100},"explode":false},{"name":"sort","in":"query","required":false,"description":"Valid values are audiencestrength, category, companybname, issuedate, signaldate, signalscore, signalstrength, surgescore, topic. Add minus sign ('-') for descending order.","schema":{"type":"string"},"explode":false}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/IntentEnrichResponse"},"examples":{"Enrich Intent Data by Topics Using Multiple Output Fields for a Full Match":{"summary":"Enrich Intent Data by Topics Using Multiple Output Fields for a Full Match","description":"This example demonstrates how to enrich intent data using the topic names as input and specifying a list of outputFields for the API to return. The response includes the number of matching records. You can include up to 25 topic inputs in a single enrich request.","value":{"data":[{"type":"Intent","id":"344589814","attributes":{"category":"Application Development","topic":"Node.js","signalScore":97,"audienceStrength":"B","signalDate":"2024-06-01T10:00:00Z","recommendedContacts":[{"id":"8800842561","firstName":"Dan","lastName":"O'Donnell","jobTitle":"Vice President, Information Technology","jobFunctions":[{"name":"Information Technology","department":"Information Technology"}]},{"id":"1165421722","firstName":"James","lastName":"Grant","jobTitle":"Vice President & Field Chief Information Security Officer","jobFunctions":[{"name":"Information Technology","department":"Information Technology"}]},{"id":"13866040380","firstName":"Jiaming","lastName":"Lin","jobTitle":"Vice President, Data & Analytics","jobFunctions":[{"name":"Information Technology","department":"Information Technology"}]}],"spikesInDateRange":2,"topSignalLocations":[{"city":"Dehradun","state":"Uttarakhand","country":"India"},{"city":"Chennai","state":"Tamil Nadu","country":"India"}],"company":{"hasOtherTopicConsumption":true,"id":"344589814","name":"ZoomInfo","website":"www.zoominfo.com"}}}],"meta":{"page":{"number":1,"total":1},"totalResults":2},"links":{"first":"/v1/intents/enrich?page[number]=1&page[size]=2","last":"/v1/intents/enrich?page[number]=1&page[size]=2"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Enrich"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/IntentEnrichRequest"},"examples":{"Enrich Intent Data by Topics Using Multiple Output Fields for a Full Match":{"summary":"Enrich Intent Data by Topics Using Multiple Output Fields for a Full Match","description":"This example demonstrates how to enrich intent data using the topic names as input and specifying a list of outputFields for the API to return. The response includes the number of matching records. You can include up to 25 topic inputs in a single enrich request.","value":{"data":{"attributes":{"companyName":"Zoominfo","topics":["Cloud Applications","Credit Card Fraud","Direct Deposit","Google Search","In-App Advertising","Java","Risk Management Services"]},"type":"IntentEnrich"}}}}}},"description":"The request body containing intent enrich criteria."},"security":[{"OAuth2Auth":["api:data:intent"]}],"x-additional-content-types":["application/json"],"x-api-roles":["fea:zia","fea:api"],"x-api-role-requirement":"ANY_REQUIRED"}},"/data/v1/news/enrich":{"post":{"operationId":"EnrichInterface_enrichNews","summary":"Enrich News","description":"Enrich the specified company with relevant News articles. A company identifier must be provided (companyId, companyName, companyWebsite); \nall other criteria are optional.\n\nInput parameters may require specific values. You can use the [Lookup Data](ref:lookupinterface_lookup)\nendpoint to retrieve the list of possible values.\n\nUse Enrich News to find News articles for a specific ZoomInfo company. To find News articles across the entire database of\nZoomInfo Companies, use the [Search News](ref:searchinterface_searchnews) endpoint.\n\nWith reference to ZoomInfo's [Credit Usage and Limits](doc:credit-usage-and-limits), a credit will be counted for the enriched\ncompany. Each News article returned in the results does count towards the customer's Record limit and a successful response \nwill count towards the Request limit. For example, a successful response that returns 10 news articles, 1 credit will be charged if\napplicable, 10 Records will be counted, and 1 Request will be counted.","parameters":[{"name":"page[number]","in":"query","required":false,"description":"Page number for the results.","schema":{"type":"integer","format":"int32","minimum":1},"explode":false},{"name":"page[size]","in":"query","required":false,"description":"Number of records to return per page. Default is 25.","schema":{"type":"integer","format":"int32","minimum":1,"maximum":100},"explode":false}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/NewsEnrichResponse"},"examples":{"Enrich news for a specified company":{"summary":"Enrich news for a specified company","description":"This example demonstrates how to enrich news data using a companyId, categoreis, pageDateMin, pageDateMax. The response includes the number of matching records. You can include a single input criteria in a single enrich request.","value":{"data":[{"type":"News","id":"article-1","attributes":{"domain":"techcrunch.com","title":"ZoomInfo Launches Revenue Intelligence Platform","url":"https://www.techcrunch.com/articles/zoominfo-revenue-intelligence","imageUrl":"https://www.techcrunch.com/images/zoominfo-revenue.jpg","pageDate":"2024-04-22T13:30:00Z","categories":["PRODUCT"],"description":"ZoomInfo has released a new platform aimed at boosting sales intelligence through AI.","company":[{"id":344589814,"name":"ZoomInfo"}]}},{"type":"News","id":"article-2","attributes":{"domain":"businessinsider.com","title":"ZoomInfo Hosts Go-To-Market Conference","url":"https://www.businessinsider.com/zoominfo-gtm-event","imageUrl":"https://www.businessinsider.com/images/gtm-event.jpg","pageDate":"2024-06-01T10:00:00Z","categories":["GENERAL_NEWS"],"description":"ZoomInfo held its annual Go-To-Market summit, attracting over 5,000 attendees.","company":[{"id":344589814,"name":"ZoomInfo"}]}}],"meta":{"page":{"number":1,"total":1},"totalResults":2},"links":{"first":"/v1/news/enrich?page[number]=1&page[size]=2","last":"/v1/news/enrich?page[number]=1&page[size]=2"}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Enrich"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/NewsEnrichRequest"},"examples":{"Enrich news for a specified company":{"summary":"Enrich news for a specified company","description":"This example demonstrates how to enrich news data using a companyId, categoreis, pageDateMin, pageDateMax. The response includes the number of matching records. You can include a single input criteria in a single enrich request.","value":{"data":{"type":"NewsEnrich","attributes":{"companyId":344589814,"categories":["PRODUCT","GENERAL_NEWS"],"pageDateMin":"2024-01-01","pageDateMax":"2024-12-31"}}}}}}},"description":"The request body containing news enrich criteria."},"security":[{"OAuth2Auth":["api:data:news"]}],"x-additional-content-types":["application/json"],"x-api-roles":["fea:zia","fea:api"],"x-api-role-requirement":"ANY_REQUIRED"}},"/data/v1/companies/org-chart/enrich":{"post":{"operationId":"EnrichInterface_enrichOrgChart","summary":"Enrich Org Charts","description":"Enrich the specified Company by providing Org Chart information. For each request, a ZoomInfo Company identifier and \nat least one ZoomInfo Department identifier are required. This endpoint then returns ZoomInfo contacts for that company \nin the requested department.\n\nOrg Chart data displays employees organized by seniority level, enabling you to understand the structural composition \nof an organization. Org Chart data can be used to identify decision makers, analyze team composition, track organizational\nchanges, and target contacts by seniority.\n\nInput parameters may require specific values. You can use the [Lookup Data](ref:lookupinterface_lookup)\nendpoint to retrieve the list of possible values.\n\nWith reference to ZoomInfo's [Credit Usage and Limits](doc:credit-usage-and-limits), a credit will be counted for the enriched\ncompany, when applicable. Regardless of the number of ZoomInfo Contacts returned, a single Record will be charged per successful\nrequest. Additionally, a Request limit will be charged for each successful request.","parameters":[{"name":"page[number]","in":"query","required":false,"description":"Page number for the results.","schema":{"type":"integer","format":"int32","minimum":1},"explode":false},{"name":"page[size]","in":"query","required":false,"description":"Number of records to return per page. Default is 25.","schema":{"type":"integer","format":"int32","minimum":1,"maximum":100},"explode":false},{"name":"sort","in":"query","required":false,"description":"Sort results by valid output fields: contactAccuracyScore and lastName. If no valid fields are specified, results default to relevance-based sorting. Add minus sign ('-') for descending order.","schema":{"type":"string"},"explode":false}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/OrgChartEnrichResponse"},"examples":{"Enrich Org Chart Data by Company ID":{"summary":"Enrich Org Chart Data by Company ID","description":"This example demonstrates how to retrieve org chart data for a company using a companyId. The response includes contact information with organizational hierarchy details and department information.","value":{"data":[{"attributes":{"firstName":"Andrew","lastName":"Riesenfeld","lastUpdatedDate":"6/19/2024 12:05 PM","title":"Chief Operations Officer","hasDirectPhone":false,"department":"C-Suite","jobFunction":"Operations Executive","orgChartTier":2,"orgChartSubTier":2,"companyId":"344589814","companyName":"ZoomInfo"},"id":"8256366202","type":"OrgChart"}],"meta":{"page":{"number":1,"total":1},"totalResults":1}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Enrich"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/OrgChartEnrichRequest"},"examples":{"Enrich Org Chart Data by Company ID":{"summary":"Enrich Org Chart Data by Company ID","description":"This example demonstrates how to retrieve org chart data for a company using a companyId. The response includes contact information with organizational hierarchy details and department information.","value":{"data":{"attributes":{"companyId":"344589814"},"type":"OrgChartEnrich"}}}}}},"description":"The request body containing org chart enrich criteria."},"security":[{"OAuth2Auth":["api:data:contact"]}],"x-additional-content-types":["application/json"],"x-api-roles":["fea:zia","fea:api"],"x-api-role-requirement":"ANY_REQUIRED"}},"/data/v1/scoops/enrich":{"post":{"operationId":"EnrichInterface_enrichScoop","summary":"Enrich Scoops","description":"Enrich the specified company with relevant Scoops. A company identifier must be provided (companyId, companyName, companyWebsite); \nall other criteria are optional.\n\nInput parameters may require specific values. You can use the [Lookup Data](ref:lookupinterface_lookup)\nendpoint to retrieve the list of possible values.\n\nUse Enrich Scoops to find Scoops for a specific ZoomInfo company. To find Scoops across the entire database of\nZoomInfo Companies, use the [Search Scoops](ref:searchinterface_searchscoop) endpoint.\n\nWith reference to ZoomInfo's [Credit Usage and Limits](doc:credit-usage-and-limits), a credit will be counted for the enriched\ncompany. Each Scoop returned in the results does count towards the customer's Record limit and a successful response \nwill count towards the Request limit. For example, a successful response that returns 10 Scoops, 1 credit will be charged if\napplicable, 10 Records will be counted, and 1 Request will be counted.","parameters":[{"name":"page[number]","in":"query","required":false,"description":"Page number for the results.","schema":{"type":"integer","format":"int32","minimum":1},"explode":false},{"name":"page[size]","in":"query","required":false,"description":"Number of records to return per page. Default is 25.","schema":{"type":"integer","format":"int32","minimum":1,"maximum":100},"explode":false},{"name":"sort","in":"query","required":false,"description":"Sort results by valid output fields: scoopId, originalPublishedDate, description, link, or linkText. Add minus sign ('-') for descending order.","schema":{"type":"string"},"explode":false}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ScoopEnrichResponse"},"examples":{"Enrich scoops by company name and multiple scoop types":{"summary":"Enrich scoops by company name and multiple scoop types","description":"This example demonstrates how to enrich scoops using the ZoomInfo API by filtering on company name and multiple scoop types. In this example, we search for ZoomInfo company scoops with scoop types '1,6,7,8' (covering various types including Awards, Events, and Facilities changes), within a date range from November 1, 2018, to June 21, 2020. The response returns 3 diverse scoops showing different types of company activities and achievements.","value":{"data":[{"type":"Scoop","id":"1811048","attributes":{"id":"1811048","company":{"id":"344589814","name":"ZoomInfo"},"description":"ZoomInfo has announced plans to move its Grand Rapids, MI office to a new 10,000 square-foot location at 435 Ionia Ave Southwest. The location is expected to open in February 2020.","originalPublishedDate":"2020-02-11T00:00:00Z","publishedDate":"2020-02-11T00:00:00Z","topics":[{"id":"34","topic":"Facilities Relocation/Expansion"}],"types":[{"id":"8","type":"Facilities Relocation / Expansion"}]}},{"type":"Scoop","id":"1725335","attributes":{"id":"1725335","company":{"id":"344589814","name":"ZoomInfo"},"description":"ZoomInfo will be sponsoring Dreamforce, which will be held November 19-22, 2019 in San Francisco, CA.","originalPublishedDate":"2019-11-12T00:00:00Z","publishedDate":"2019-11-12T00:00:00Z","topics":[{"id":"38","topic":"Events"}],"types":[{"id":"7","type":"Event"}]}},{"type":"Scoop","id":"1620555","attributes":{"id":"1620555","company":{"id":"344589814","name":"ZoomInfo"},"description":"ZoomInfo has been ranked #2423 on the 2019 Inc. 5000 list, which recognizes the fastest-growing privately-held companies in the United States.","originalPublishedDate":"2019-08-27T00:00:00Z","publishedDate":"2019-08-27T00:00:00Z","topics":[{"id":"5","topic":"Award"}],"types":[{"id":"6","type":"Award"}]}}],"links":{"first":"uri=/data/v1/scoops/enrich?page[number]=1&page[size]=25","last":"uri=/data/v1/scoops/enrich?page[number]=1&page[size]=25"},"meta":{"page":{"number":1,"total":3},"totalResults":3}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Enrich"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ScoopEnrichRequest"},"examples":{"Enrich scoops by company name and multiple scoop types":{"summary":"Enrich scoops by company name and multiple scoop types","description":"This example demonstrates how to enrich scoops using the ZoomInfo API by filtering on company name and multiple scoop types. In this example, we search for ZoomInfo company scoops with scoop types '1,6,7,8' (covering various types including Awards, Events, and Facilities changes), within a date range from November 1, 2018, to June 21, 2020. The response returns 3 diverse scoops showing different types of company activities and achievements.","value":{"data":{"type":"ScoopEnrich","attributes":{"publishedStartDate":"2018-11-01","publishedEndDate":"2020-06-21","scoopType":"1,6,7,8","companyName":"ZoomInfo"}}}}}}},"description":"The request body containing news enrich criteria."},"security":[{"OAuth2Auth":["api:data:scoops"]}],"x-additional-content-types":["application/json"],"x-api-roles":["fea:zia","fea:api"],"x-api-role-requirement":"ANY_REQUIRED"}},"/data/v1/companies/technologies/enrich":{"post":{"operationId":"EnrichInterface_enrichTechnology","summary":"Enrich Technologies","description":"Return a list of technologies from ZoomInfo's company data that match to the provided company. Technologies data provides\na list of technologies that ZoomInfo has identified the matched company is using. These technologies are identified through\nanalyzing company websites, analyzing job postings, company and partnership announcements, data partnerships, ai models, and \nmany other methods.\n\nWith reference to ZoomInfo's [Credit Usage and Limits](doc:credit-usage-and-limits), this endpoint will charge a single credit\nfor the company that is enriched, and the company is also counted as a Record. Each successful response will count as a \nRequest credit.","parameters":[],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/TechnologyEnrichResponse"},"examples":{"Enrich technologies for a specified company":{"summary":"Enrich technologies for a specified company","description":"This example demonstrates how to enrich technologies data using a companyId. The response includes the technologies associated for that company. You can include a single input criteria in a single enrich request.","value":{"data":[{"type":"Technology","id":"24128","attributes":{"attribute":"333.198.20393979","category":"File Sharing","categoryParent":"Communication and Collaboration","createdDate":"2016-07-16","description":"Jupyter is an open source project that offers a web application for making and sharing documents. It supports more than 40 programming languages, allows sharing notebooks with others, manages authentication, and leverages big data tools.","domain":"jupyter.org","logo":"https://res.cloudinary.com/zoominfo-com/image/upload/w_100,h_100,c_fit/jupyter.org","modifiedDate":"2020-12-08","product":"Jupyter","vendor":"Project Jupyter","website":"http://jupyter.org/"}}],"meta":{"totalResults":1}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Enrich"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/TechnologyEnrichRequest"},"examples":{"Enrich technologies for a specified company":{"summary":"Enrich technologies for a specified company","description":"This example demonstrates how to enrich technologies data using a companyId. The response includes the technologies associated for that company. You can include a single input criteria in a single enrich request.","value":{"data":{"type":"TechnologyEnrich","attributes":{"companyId":344589814}}}}}}},"description":"The request body containing company technologies enrich criteria."},"security":[{"OAuth2Auth":["api:data:company"]}],"x-additional-content-types":["application/json"],"x-api-roles":["fea:zia","fea:api"],"x-api-role-requirement":"ANY_REQUIRED"}},"/data/v1/companies/hashtags/enrich":{"post":{"operationId":"EnrichInterface_enrichHashtag","summary":"Enrich Hashtags","description":"Return a list of hashtags from ZoomInfo's company data that match to the provided company. Hashtags are predefined\ncategorical labels that classify companies based on specific business characteristics, technologies, or attributes.\nThey function as structured metadata tags that enable precise filtering and segmentation of companies in the ZoomInfo database.\n\nWith reference to ZoomInfo's [Credit Usage and Limits](doc:credit-usage-and-limits), this endpoint will charge a single credit\nfor the company that is enriched, and the company is also counted as a Record. Each successful response will count as a \nRequest credit.","parameters":[],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/HashtagEnrichResponse"},"examples":{"Enrich hashtags for a specified company":{"summary":"Enrich hashtags for a specified company","description":"This example demonstrates how to enrich hashtags data using a companyId. The response includes the hashtags associated for that company. You can include a single input criteria in a single enrich request.","value":{"data":[{"type":"Hashtag","id":"#250_plus_operations","attributes":{"categorizedFlag":false,"description":"This company has 250 or more employees in an operations role","displayLabel":"250+ Operations Employees","displayScore":"yes","group":"Number of Operations Employees","hidden":false,"label":"250+ Operations Employees","parentCategory":"Job Function","priority":250,"searchString":"250 operations employees"}}],"meta":{"totalResults":1}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Enrich"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/HashtagEnrichRequest"},"examples":{"Enrich hashtags for a specified company":{"summary":"Enrich hashtags for a specified company","description":"This example demonstrates how to enrich hashtags data using a companyId. The response includes the hashtags associated for that company. You can include a single input criteria in a single enrich request.","value":{"data":{"type":"HashtagEnrich","attributes":{"companyId":344589814}}}}}}},"description":"The request body containing company hashtag enrich criteria."},"security":[{"OAuth2Auth":["api:data:company"]}],"x-additional-content-types":["application/json"],"x-api-roles":["fea:zia","fea:api"],"x-api-role-requirement":"ANY_REQUIRED"}},"/data/v1/lookup/{fieldName}":{"get":{"operationId":"LookupInterface_lookup","summary":"Lookup Data","description":"Returns lookup data.","parameters":[{"name":"fieldName","in":"path","required":true,"description":"The name of the lookup field e.g. 'company-rankings'","schema":{"$ref":"#/components/schemas/FieldNameEnum"}},{"name":"filter[category]","in":"query","required":false,"description":"The category of the lookup field. Only applicable when accessing hashtag lookups e.g. 'Unified Communications'","schema":{"type":"string"},"explode":false},{"name":"filter[parentCategory]","in":"query","required":false,"description":"The parentCategory. Only applicable when accessing hashtag and tech lookups e.g. 'Communication and Collaboration'","schema":{"type":"string"},"explode":false},{"name":"filter[subCategory]","in":"query","required":false,"description":"The subCategory. Only applicable when accessing hashtag and tech lookups e.g. 'Unified Communications as a Service'","schema":{"type":"string"},"explode":false},{"name":"filter[vendor]","in":"query","required":false,"description":"The vendor of the lookup field. Only applicable when accessing hashtag and tech lookups e.g. 'microsoft corporation'","schema":{"type":"string"},"explode":false}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/LookupResponse"},"examples":{"Look up board member filters":{"summary":"Look up board member filters","description":"This example demonstrates how to look up board member filters using the ZoomInfo API. The response includes a sample list of available filters for board members.","value":{"data":[{"attributes":{"name":"exclude"},"id":"exclude","type":"BoardMember"},{"attributes":{"name":"include"},"id":"include","type":"BoardMember"}]}},"Look up buying groups":{"summary":"Look up buying groups","description":"This example demonstrates how to look up buying groups using the ZoomInfo API. The response includes a sample list of available buying group types.","value":{"data":[{"attributes":{"accessLevel":"private","isDefault":false,"name":"HR Decision Makers","personas":[{"departmentsAndJobFunctions":["Human Resources"],"managementLevels":["C_EXECUTIVES","VP_EXECUTIVES","DIRECTOR","MANAGER"],"titles":null}]},"id":"1913024","type":"BuyingGroup"},{"attributes":{"accessLevel":"private","isDefault":false,"name":"SecondTestGroup","personas":[{"departmentsAndJobFunctions":["Medical & Health"],"managementLevels":["VP_EXECUTIVES"],"titles":["Dentist"]}]},"id":"1913025","type":"BuyingGroup"}]}},"Look up company rankings":{"summary":"Look up company rankings","description":"This example demonstrates how to look up company rankings using the ZoomInfo API. The response includes a sample company ranking.","value":{"data":[{"attributes":{"name":"Fortune 500"},"id":"fortune500","type":"CompanyRanking"}]}},"Look up company types":{"summary":"Look up company types","description":"This example demonstrates how to look up company types using the ZoomInfo API. The response includes a sample company type.","value":{"data":[{"attributes":{"name":"private"},"id":"private","type":"CompanyType"}]}},"Look up continents":{"summary":"Look up continents","description":"This example demonstrates how to look up continents using the ZoomInfo API. The response includes a sample continent.","value":{"data":[{"attributes":{"name":"Africa"},"id":"africa","type":"Continent"}]}},"Look up countries":{"summary":"Look up countries","description":"This example demonstrates how to look up countries using the ZoomInfo API. The response includes a sample country.","value":{"data":[{"attributes":{"name":"Bahamas"},"id":"bahamas","type":"Country"}]}},"Look up departments":{"summary":"Look up departments","description":"This example demonstrates how to look up departments using the ZoomInfo API. The response includes a sample department.","value":{"data":[{"attributes":{"name":"Information Technology"},"id":"5","type":"Department"}]}},"Look up employee count ranges":{"summary":"Look up employee count ranges","description":"This example demonstrates how to look up employee count ranges using the ZoomInfo API. The response includes a sample employee count range.","value":{"data":[{"attributes":{"name":"1 - 5"},"id":"1to4","type":"EmployeeCount"}]}},"Look up hashtag results":{"summary":"Look up hashtag results","description":"This example demonstrates how to look up hashtag results using the API. The response includes a sample hashtag result.","value":{"data":[{"attributes":{"name":"250+ Doctors"},"id":"#250_plus_doctors","type":"Hashtag"}]}},"Look up industry categories":{"summary":"Look up industry categories","description":"This example demonstrates how to look up industry categories using the API. The response includes a sample industry category.","value":{"data":[{"attributes":{"name":"Animals & Livestock"},"id":"agriculture.animals","type":"Industry"}]}},"Look up intent topics":{"summary":"Look up intent topics","description":"This example demonstrates how to look up intent topics using the ZoomInfo API. The response includes a sample intent topic.","value":{"data":[{"attributes":{"category":"Cloud","department":"Information Technology","description":"","jobFunction":"Cloud / Mobility","name":"Cloud Applications"},"id":"Cloud Applications","type":"IntentTopic"}]}},"Look up job functions":{"summary":"Look up job functions","description":"This example demonstrates how to look up job functions using the API. The response includes a sample job function.","value":{"data":[{"attributes":{"name":"Project Development"},"id":"4.11","type":"JobFunction"}]}},"Look up job title hierarchies":{"summary":"Look up job title hierarchies","description":"This example demonstrates how to look up job titles using the ZoomInfo API. The response includes samples of job titles.","value":{"data":[{"attributes":{"name":"C-Level","order":"2"},"id":"exec","type":"JobTitle"},{"attributes":{"name":"VP-Level","order":"3"},"id":"vp","type":"JobTitle"}]}},"Look up management levels":{"summary":"Look up management levels","description":"This example demonstrates how to look up management levels using the API. The response includes a sample management level.","value":{"data":[{"attributes":{"name":"VP Level Execs"},"id":"VP Level Exec","type":"ManagementLevel"}]}},"Look up metro region":{"summary":"Look up metro region","description":"This example demonstrates how to look up metro refions using the ZoomInfo API. The response includes a sample metro region.","value":{"data":[{"attributes":{"name":"AL - Birmingham"},"id":"usa.alabama.birmingham","type":"MetroRegion"}]}},"Look up NAICS codes":{"summary":"Look up NAICS codes","description":"This example demonstrates how to look up NAICS codes using the API. The response includes a sample NAICS code.","value":{"data":[{"attributes":{"name":"Soybean Farming"},"id":"11111","type":"NAICSCode"}]}},"Look up news categories":{"summary":"Look up news categories","description":"This example demonstrates how to look up news categories using the API. The response includes a sample news category.","value":{"data":[{"attributes":{"name":"GENERAL_NEWS"},"id":"GENERAL_NEWS","type":"NewsCategory"}]}},"Look up revenue ranges":{"summary":"Look up revenue ranges","description":"This example demonstrates how to look up revenue ranges using the API. The response includes a sample revenue range.","value":{"data":[{"attributes":{"name":"500"},"id":"under500k","type":"RevenueRange"}]}},"Look up scoop departments":{"summary":"Look up scoop departments","description":"This example demonstrates how to look up scoop departments using the API. The response includes a sample scoop department.","value":{"data":[{"attributes":{"name":"Sales"},"id":"5","type":"ScoopDepartment"}]}},"Look up scoop topics":{"summary":"Look up scoop topics","description":"This example demonstrates how to look up scoop topics using the API. The response includes a sample scoop topic.","value":{"data":[{"attributes":{"name":"Award"},"id":"5","type":"ScoopTopic"}]}},"Look up scoop types":{"summary":"Look up scoop types","description":"This example demonstrates how to look up scoop types using the API. The response includes a sample scoop type.","value":{"data":[{"attributes":{"name":"Divestiture"},"id":"5","type":"ScoopType"}]}},"Look up SIC codes":{"summary":"Look up SIC codes","description":"This example demonstrates how to look up SIC codes using the API. The response includes a sample SIC code.","value":{"data":[{"attributes":{"name":"Rice"},"id":"0112","type":"SICCode"}]}},"Look up states":{"summary":"Look up states","description":"This example demonstrates how to look up states using the ZoomInfo API. The response includes a sample state.","value":{"data":[{"attributes":{"name":"Alaska"},"id":"usa.alaska","type":"State"}]}},"Look up sub-unit types":{"summary":"Look up sub-unit types","description":"This example demonstrates how to look up sub-unit types using the API. The response includes a sample sub-unit type.","value":{"data":[{"attributes":{"name":"UNSPECIFIED"},"id":"UNSPECIFIED","type":"SubUnitType"}]}},"Look up tech categories":{"summary":"Look up tech categories","description":"This example demonstrates how to look up tech categories using the API. The response includes a sample tech category.","value":{"data":[{"attributes":{"categories":["Applicant Tracking Systems"]},"id":"Human Resources","type":"TechCategory"}]}},"Look up tech products":{"summary":"Look up tech products","description":"This example demonstrates how to look up tech products using the API. The response includes a sample tech products.","value":{"data":[{"attributes":{"name":"Skype for Business","attribute":"333.202.28.24617"},"id":"24617","type":"TechProduct"}]}},"Look up tech skills":{"summary":"Look up tech skills","description":"This example demonstrates how to look up tech skills using the API. The response includes a sample tech skills.","value":{"data":[{"attributes":{"name":"talentReef"},"id":"1000","type":"TechSkill"}]}},"Look up tech vendors":{"summary":"Look up tech vendors","description":"This example demonstrates how to look up tech vendors using the API. The response includes a sample tech vendor.","value":{"data":[{"attributes":{"name":"Appier Inc."},"id":"Appier Inc.","type":"TechVendor"}]}},"Look up ranges for years of experience":{"summary":"Look up ranges for years of experience","description":"This example demonstrates how to look up ranges for years of experience using the API. The response includes a sample years of experience range.","value":{"data":[{"attributes":{"name":"4-5"},"id":"4-5","type":"YearsOfExperience"}]}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Lookup"],"security":[{"OAuth2Auth":["api:data:company","api:data:contact","api:data:intent","api:data:news","api:data:scoops","api:data:lookup"]}],"x-api-roles":["fea:zia","fea:api"],"x-api-role-requirement":"ANY_REQUIRED","x-api-scope-requirement":"ANY_REQUIRED"}},"/data/v1/lookup/search":{"get":{"operationId":"LookupSearchInterface_lookupSearch","summary":"Lookup Search Fields","description":"Returns lookup search fields based on entity and field type filters.","parameters":[{"name":"filter[entity]","in":"query","required":true,"description":"The entity type to filter by. Options are 'contact', 'company', 'scoop', 'news', or 'intent'.","schema":{"$ref":"#/components/schemas/SearchEntityNameEnum"},"explode":false},{"name":"filter[fieldType]","in":"query","required":true,"description":"The field type to filter by. Options are 'input' or 'output'.","schema":{"$ref":"#/components/schemas/FieldTypeEnum"},"explode":false}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/LookupSearchResponse"}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Lookup"],"security":[{"OAuth2Auth":["api:data:company","api:data:contact","api:data:intent","api:data:news","api:data:scoops","api:data:lookup"]}],"x-api-roles":["fea:zia","fea:api"],"x-api-role-requirement":"ANY_REQUIRED","x-api-scope-requirement":"ANY_REQUIRED"}},"/data/v1/lookup/enrich":{"get":{"operationId":"LookupEnrichInterface_lookupEnrich","summary":"Lookup Enrich Fields","description":"Returns lookup enrich fields based on entity and field type filters.","parameters":[{"name":"filter[entity]","in":"query","required":true,"description":"The entity type to filter by. Options are 'contact', 'company', 'scoop', 'news', 'intent', 'technology', 'orgChart', or 'corporate-hierarchy'.","schema":{"$ref":"#/components/schemas/EnrichEntityNameEnum"},"explode":false},{"name":"filter[fieldType]","in":"query","required":true,"description":"The field type to filter by. Options are 'input' or 'output'.","schema":{"$ref":"#/components/schemas/FieldTypeEnum"},"explode":false}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/LookupEnrichResponse"}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Lookup"],"security":[{"OAuth2Auth":["api:data:company","api:data:contact","api:data:intent","api:data:news","api:data:scoops","api:data:lookup"]}],"x-api-roles":["fea:zia","fea:api"],"x-api-role-requirement":"ANY_REQUIRED","x-api-scope-requirement":"ANY_REQUIRED"}},"/data/v1/users/usage":{"get":{"operationId":"UserInterface_userUsage","summary":"Usage Data","description":"Returns current user's API usage and limits.","parameters":[],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/UsageResponse"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["User"],"security":[{"OAuth2Auth":["api:data:company","api:data:contact","api:data:intent","api:data:news","api:data:scoops","api:data:lookup"]}],"x-api-roles":["fea:zia","fea:api"],"x-api-role-requirement":"ANY_REQUIRED","x-api-scope-requirement":"ANY_REQUIRED"}}},"security":[{"OAuth2Auth":[]}],"components":{"schemas":{"ManagementStatus":{"type":"object","properties":{"underManagement":{"type":"boolean","description":"Indicates whether record is under management within the contract period."},"purchaseDate":{"type":"string","format":"date-time","description":"Indicates when record was purchased if it is under management."}},"description":"Management status of the record."},"ContactCompanySearch":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Unique ZoomInfo identifier for a company."},"name":{"type":"string","description":"Company Name."}},"description":"Contact's company data."},"ContactSearchResponseAttributes":{"type":"object","properties":{"firstName":{"type":"string","description":"Contact first name."},"middleName":{"type":"string","description":"Contact middle name."},"lastName":{"type":"string","description":"Contact last name."},"validDate":{"type":"string","format":"date-time","description":"Date on which the contact record was last validated."},"lastUpdatedDate":{"type":"string","format":"date-time","description":"Date on which the contact record was last updated."},"jobTitle":{"type":"string","description":"Contact job title at current place of employment."},"contactAccuracyScore":{"type":"number","format":"double","description":"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."},"managementLevel":{"type":"string","description":"Comma-separated list of contact management levels."},"school":{"type":"string","description":"Get last Education information."},"hasEmail":{"type":"boolean","description":"Indicates whether ZoomInfo has an email address for the contact."},"hasSupplementalEmail":{"type":"boolean","description":"Indicates whether ZoomInfo has a supplemental email address for the contact."},"hasDirectPhone":{"type":"boolean","description":"Indicates whether ZoomInfo has a direct phone number for the contact."},"hasMobilePhone":{"type":"boolean","description":"Indicates whether ZoomInfo has a mobile phone number for the contact."},"hasCompanyIndustry":{"type":"boolean","description":"Indicates whether ZoomInfo has company industry for the contact."},"hasCompanyPhone":{"type":"boolean","description":"Indicates whether ZoomInfo has a company phone number for the contact."},"hasCompanyStreet":{"type":"boolean","description":"Indicates whether ZoomInfo has a street address for the contact."},"hasCompanyState":{"type":"boolean","description":"Indicates whether ZoomInfo has a state for the contact."},"hasCompanyZipCode":{"type":"boolean","description":"Indicates whether ZoomInfo has a zip code or postal code for the contact."},"hasCompanyCountry":{"type":"boolean","description":"Indicates whether ZoomInfo has a country for the contact."},"hasCompanyRevenue":{"type":"boolean","description":"Indicates whether ZoomInfo has company revenue data for the contact."},"hasCompanyEmployeeCount":{"type":"boolean","description":"Indicates whether ZoomInfo has company headcount data for the contact."},"directPhoneDoNotCall":{"type":"boolean","description":"Contact flagged with do not call for direct phone."},"mobilePhoneDoNotCall":{"type":"boolean","description":"Contact flagged with do not call for mobile phone."},"managementStatus":{"allOf":[{"$ref":"#/components/schemas/ManagementStatus"}],"description":"Management status of the record."},"company":{"allOf":[{"$ref":"#/components/schemas/ContactCompanySearch"}],"description":"Contact's company data for search request."}},"description":"Response attributes for contact search.","x-class-extra-annotation":"@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true)"},"Contact":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"Contact","pattern":"Contact"},"attributes":{"allOf":[{"$ref":"#/components/schemas/ContactSearchResponseAttributes"}],"description":"The attributes defining the resource"}},"description":"ZoomInfo Contact"},"Page":{"type":"object","required":["total","number"],"properties":{"total":{"type":"integer","format":"uint32","description":"The total number of pages within the current result set"},"number":{"type":"integer","format":"uint32","description":"The current page number of the results"}},"description":"Meta information related to the current page and total number of pages"},"ResultMeta":{"type":"object","required":["totalResults","page"],"properties":{"totalResults":{"type":"integer","format":"uint32","description":"The total number of results based on the specified filters"},"page":{"allOf":[{"$ref":"#/components/schemas/Page"}],"description":"Paging information for the current result set"}},"description":"Metadata including paging information and the total number of records in the result set"},"Links":{"type":"object","properties":{"first":{"type":"string","format":"uri","description":"A link to the first page of data"},"last":{"type":"string","format":"uri","description":"A link to the last page of data"},"prev":{"type":"string","format":"uri","description":"A link to the previous page of data"},"next":{"type":"string","format":"uri","description":"A link to the next page of data"}},"description":"Helpful links for fetching different pages of data from the current result set. When using these links, please provide the exact same request body between requests"},"ContactSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Contact"},"description":"The primary data of the document"},"meta":{"allOf":[{"$ref":"#/components/schemas/ResultMeta"}],"description":"Non-standard meta information about the document"},"links":{"allOf":[{"$ref":"#/components/schemas/Links"}],"description":"Links related to the primary data"}},"description":"A list of contacts that match the criteria specified in the request"},"ZoomInfo.Core.Foundations.ErrorSourceModel":{"type":"object","properties":{"cookie":{"type":"string","description":"Identifies the cookie name that caused the issue"},"header":{"type":"string","description":"Identifies the header name that caused the error"},"pointer":{"type":"string","description":"An RFC 6901 compliant JSON pointer to the entity in the request body that caused the error"},"parameter":{"type":"string","description":"The name of the path or query parameter that caused the error"}}},"ZoomInfo.Core.Foundations.ErrorModel":{"type":"object","required":["id","code","status"],"properties":{"id":{"type":"string","description":"The unique id used to identify this specific error instance"},"code":{"type":"string","description":"The error code describing the error category. A full list of error codes can be found in the documentation for each service"},"detail":{"type":"string","description":"Message containing the specific details about this occurrence of the error"},"source":{"allOf":[{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorSourceModel"}],"description":"An optional object identifying which part of the request caused the error"},"status":{"type":"string","description":"The HTTP status code for the error"},"title":{"type":"string","description":"The error name that describes this type of error"}},"description":"The object describing a specific error from the API"},"ZoomInfo.Core.Foundations.ErrorResponseModel":{"type":"object","required":["errors"],"properties":{"detail":{"type":"string","description":"A high-level detail of the error(s) that occurred during the request"},"title":{"type":"string","description":"A high-level summary of the error(s) detected"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorModel"},"description":"The list of errors raised during the request"}},"description":"The standard error response body model for the ZoomInfo API."},"ContactsEmploymentHistory":{"type":"object","required":["companyName","jobTitle"],"properties":{"companyName":{"type":"string","description":"Company name of past employment."},"jobTitle":{"type":"string","description":"Job title at past employment."}},"description":"Contact's past employment information used for contact search criteria."},"ContactSearchRequestAttributes":{"type":"object","properties":{"lastUpdatedDateAfter":{"type":"string","format":"date","description":"Limit results to only contacts that have a `lastUpdateDate` **after** the provided value.\nThe value must be a date formatted using the ISO 8601 date format (YYYY-MM-DD).\n\nExample value: `2024-01-01` will return only contacts with a `lastUpdatedDate` after January 1, 2024"},"validDateAfter":{"type":"string","format":"date","description":"Limit results to only contacts that have a `validDate` **after** the provided value.\nThe value must be a date formatted using the ISO 8601 date format (YYYY-MM-DD)\n\nExample value: `2024-01-01` will return only contacts with a `validDate` after January 1, 2024"},"phone":{"type":"array","items":{"type":"string"},"description":"List of phone numbers used to locate the contacts your are searching for. The phone numbers can either\nbe direct dial office phone numbers or mobile phone numbers. Contacts will be returned if they match a single\nphone number from the provided list. Phone numbers can be formatted in any standard format as all non-digit\ncharacters will be stripped before searching.\n\nExample: `800-555-2345` is functionally equivalent to `8005552345` as an input value"},"positionStartDateMin":{"type":"string","format":"date","description":"Minimum date for when a contact began current employment. Use with positionStartDateMax to set a range. Uses YYYY-MM-DD format."},"positionStartDateMax":{"type":"string","format":"date","description":"Maximum date for when a contact began current employment. Use with positionStartDateMin to set a range. Uses YYYY-MM-DD format."},"supplementalEmail":{"type":"array","items":{"type":"string"},"description":"Supplemental email address for the contact in example@example.com format."},"webReferences":{"type":"array","items":{"type":"string"},"description":"List of Web References for a contact. Default criteria is OR between multiple values. Should only contain english letters and numbers."},"buyingGroup":{"type":"array","items":{"type":"string"},"description":"Filters results based on the provided Buying Group ID. Only one ID can be submitted."},"techSkills":{"type":"array","items":{"type":"string"},"description":"List of technology skill IDs for a contact. Default criteria is OR between multiple values. Should only contain string numbers. Find the IDs for the skills in the lookup endpoint."},"yearsOfExperience":{"type":"string","description":"Total years of experience. Accepts a comma-separated list."},"personId":{"type":"string","description":"Unique ZoomInfo identifier for the contact. Can include a comma-separated list."},"emailAddress":{"type":"string","description":"Email address for the contact in example@example.com format."},"hashedEmail":{"type":"string","description":"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."},"fullName":{"type":"string","description":"Contact full name."},"firstName":{"type":"string","description":"Contact first name."},"middleInitial":{"type":"string","description":"Contact middle initial."},"lastName":{"type":"string","description":"Contact last name."},"jobTitle":{"type":"string","description":"Contact title at current place of employment. Use OR to input multiple job titles."},"exactJobTitle":{"type":"string","description":"Contact title at current place of employment using exact match logic. Use OR to input multiple job titles."},"excludeJobTitle":{"type":"string","description":"Comma-separated list of job titles to exclude from search results."},"managementLevel":{"type":"string","description":"Contact management level at current place of employment."},"excludeManagementLevel":{"type":"string","description":"Comma-separated list of management levels to exclude from search results."},"department":{"type":"string","description":"Contact department at current place of employment. Accepts a comma-separated list of values."},"boardMember":{"type":"string","description":"Exclude or include board members from search results. Default behavior is to exclude board members from search results. Submit this as “include” to include board members, set this as “only” to only include board members."},"excludePartialProfiles":{"type":"boolean","description":"Defaults to false. To include partial profiles in your search results, set this to true. Contacts who do not have an active company associated with them are considered partial profiles."},"executivesOnly":{"type":"boolean","description":"Defaults to false. Set this to true to include only executives in search results."},"requiredFields":{"type":"string","description":"Specify a list of required fields for each record returned. Can include email (business email), phone (direct or company phone), directPhone (contact's direct phone), personalEmail, and mobilePhone. Can include a comma-separated list of these fields."},"contactAccuracyScoreMin":{"type":"string","description":"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."},"contactAccuracyScoreMax":{"type":"string","description":"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."},"jobFunction":{"type":"string","description":"Contact job function at their current place of employment."},"lastUpdatedInMonths":{"type":"integer","format":"int32","description":"Number of months within which the contact's profile was last updated."},"hasBeenNotified":{"type":"string","description":"Defaults to include. Set this to “exclude” to exclude contacts who have been notified of inclusion in ZoomInfo's database. Set this to “only” to only include contacts who have been notified."},"companyPastOrPresent":{"type":"string","description":"Defaults to only include the present company for a contact. Set this to “past” to return past companies, set this to “pastAndPresent” to include both."},"school":{"type":"string","description":"School name."},"degree":{"type":"string","description":"Searches by contact's education."},"locationCompanyId":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Searches by contact's locationIds."},"underManagement":{"type":"boolean","description":"Returns whether or not record is under management if set to true."},"employmentHistory":{"type":"array","items":{"$ref":"#/components/schemas/ContactsEmploymentHistory"},"maxItems":5,"description":"Search by contact's past employments. Accepts an array of past employment criteria. Contacts matching ANY of the provided past employment records will be returned."},"companyTicker":{"type":"array","items":{"type":"string"},"description":"Company stock ticker symbol."},"companyDescription":{"type":"string","description":"Search for companies based on description. Accepts a space-separated list of individual words."},"companyType":{"type":"string","description":"Company type (private, public, etc.). Accepts a comma-separated list of types."},"address":{"type":"string","description":"Full Company Address."},"street":{"type":"string","description":"Street address portion of the company's location."},"state":{"type":"string","description":"State or province of the company's address."},"zipCode":{"type":"string","description":"Zip Code or Postal Code of the company's address."},"country":{"type":"string","description":"Country of the primary address of the associated company."},"continent":{"type":"string","description":"Continent of the primary address of the associated company."},"zipCodeRadiusMiles":{"type":"integer","format":"int16","description":"Used in conjunction with zipCode, designates a geographical radius (in miles) from the zipCode provided. Supported values are [10, 25, 50, 100, 250]"},"hashTagString":{"type":"string","description":"Hash tags for a company. Can include a comma-separated list."},"techAttributeTagList":{"type":"string","description":"Technology Product Tags. Can include a comma-separated list."},"primaryIndustriesOnly":{"type":"boolean","description":"Default is false. 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."},"subUnitTypes":{"type":"string","description":"Company sub types (e.g., division, subsidiary). Use this in conjunction with parentId or ultimateParentId."},"industryCodes":{"type":"string","description":"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."},"industryKeywords":{"type":"string","description":"Industry keywords associated with a company. Can include either 'AND' or 'OR' operators. For example, 'software AND security' or 'software OR security'"},"sicCodes":{"type":"string","description":"The Standard Industrial Classification is a system for classifying industries by a four-digit code numerical assigned by the U.S. government to business establishments to identify the primary business of the establishment. Accepts a comma-separated list."},"naicsCodes":{"type":"string","description":"Four-digit numerical codes assigned by the U.S. government to business establishments to identify the primary business of the establishment. Accepts a comma-separated list of values."},"revenue":{"type":"string","description":"Annual revenue range in U.S. dollars. Accepts a comma-separated list of values."},"revenueMin":{"type":"integer","format":"int32","description":"Minimum annual revenue for a company in U.S. dollars (expressed in thousands). Use with revenueMax to set a range."},"revenueMax":{"type":"integer","format":"int32","description":"Maximum annual revenue for a company in U.S. dollars (expressed in thousands). Use with revenueMin to set a range."},"employeeRangeMin":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"Employee count range. Accepts a comma-separated list of values. Alternatively, for more granular ranges, you can use the employeeRangeMin and employeeRangeMax parameters."},"companyRanking":{"type":"string","description":"Company ranking (e.g., Fortune 500). Accepts a comma-separated list of IDs."},"metroRegion":{"type":"string","description":"Company metro area. Accepts a comma-separated list of U.S. and Canada metro areas."},"locationSearchType":{"type":"string","description":"Location type (PersonOrHQ, PersonAndHQ, Person, HQ, PersonThenHQ)."},"fundingAmountMin":{"type":"integer","format":"int32","description":"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":{"type":"integer","format":"int32","description":"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":{"type":"string","format":"date","description":"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":{"type":"string","format":"date","description":"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."},"zoominfoContactsMin":{"type":"string","description":"Minimum number of ZoomInfo contacts associated with company."},"zoominfoContactsMax":{"type":"string","description":"Maximum number of ZoomInfo contacts associated with company."},"excludedRegions":{"type":"string","description":"Accepts a comma-separated list of U.S. and Canada states and metro areas. Companies from any of these regions will be excluded from search results."},"companyStructureIncludedSubUnitTypes":{"type":"string","description":"Company hierarchical structure values. Accepts a comma-separated list of values from 'UNSPECIFIED', 'LOCATION', 'DIVISION', 'ACQUISITION', 'SUBSIDIARY', 'FORMER_NEW_NAME'."},"oneYearEmployeeGrowthRateMin":{"type":"string","description":"Minimum one year employee growth rate for a company. Use with oneYearEmployeeGrowthRateMax to set a range."},"oneYearEmployeeGrowthRateMax":{"type":"string","description":"Maximum one year employee growth rate for a company. Use with oneYearEmployeeGrowthRateMin to set a range."},"twoYearEmployeeGrowthRateMin":{"type":"string","description":"Minimum two year employee growth rate for a company. Use with twoYearEmployeeGrowthRateMax to set a range."},"twoYearEmployeeGrowthRateMax":{"type":"string","description":"Maximum two year employee growth rate for a company. Use with twoYearEmployeeGrowthRateMin to set a range."},"parentId":{"type":"string","description":"ZoomInfo Company ID for parent company."},"ultimateParentId":{"type":"string","description":"Company sub types (e.g., division, subsidiary). Use this in conjunction with parentId or ultimateParentId."},"companyId":{"type":"string","description":"Unique ZoomInfo identifier for a company."},"companyName":{"type":"string","description":"Company name."},"companyWebsite":{"type":"string","description":"Company website URL in http://www.example.com format. Accepts a comma-separated list."},"engagementStartDate":{"type":"string","format":"date","description":"Engagement start date in YYYY-MM-DD format."},"engagementEndDate":{"type":"string","format":"date","description":"Engagement end date in YYYY-MM-DD format. EngagementStartDate is required."},"engagementType":{"type":"array","items":{"type":"string"},"description":"List of engagement types to search for. Accepted values are 'email', 'phone', 'online meeting'. Accepts a comma-separated list of these values."},"excludeTechAttributeTagList":{"type":"string","description":"Exclude companies with these technology product tags. String can be one value ('131315') or a comma-separated list which is treated as OR logic ('131315, 132222'). Individual values can also include AND logic ('131315 AND 131301, 132222'). This last example would be evaluated as ((131201 AND 131301) OR 132222)."}},"description":"Request Attributes for contact search."},"ContactSearchResource":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"The type of the resource","default":"ContactSearch","pattern":"ContactSearch"},"attributes":{"allOf":[{"$ref":"#/components/schemas/ContactSearchRequestAttributes"}],"description":"The attributes defining the resource"}},"description":"Contact search request resource."},"ContactSearchRequest":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/ContactSearchResource"}],"description":"The primary data of the document"}},"description":"Contact search request."},"CompanySearchResponseAttributes":{"type":"object","properties":{"name":{"type":"string","description":"Company Name."},"city":{"type":"string","description":"City of the company's primary address."},"state":{"type":"string","description":"State or province of the company's primary address."},"country":{"type":"string","description":"Country of the company's primary address."},"revenue":{"type":"string","description":"Approximate yearly revenue for the company in 1000's. For example, a 100M company is expressed as 100000."},"employeeCount":{"type":"string","description":"Approximate number of people employed by the company."},"website":{"type":"string","description":"Company website URL."},"logo":{"type":"string","description":"The URL which can be used to retrieve the logo for the company."},"managementStatus":{"allOf":[{"$ref":"#/components/schemas/ManagementStatus"}],"description":"Management status of the record."}},"description":"Response attributes for company search.","x-class-extra-annotation":"@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true)"},"CompanyResponse":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"Company","pattern":"Company"},"attributes":{"allOf":[{"$ref":"#/components/schemas/CompanySearchResponseAttributes"}],"description":"The attributes defining the resource"}},"description":"ZoomInfo Company"},"CompanySearchResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CompanyResponse"},"description":"The primary data of the document"},"meta":{"allOf":[{"$ref":"#/components/schemas/ResultMeta"}],"description":"Non-standard meta information about the document"},"links":{"allOf":[{"$ref":"#/components/schemas/Links"}],"description":"Links related to the primary data"}},"description":"A list of companies that match the criteria specified in the request"},"CompanySearchRequestAttributes":{"type":"object","properties":{"marketingDepartmentBudgetMin":{"type":"integer","format":"int32","description":"Minimum marketing department budget amount in thousands (e.g., 1 = 1000, 500 = 500,000).  Minimum value is 0, maximum value is 2147483647 (approximately 2 trillion)."},"marketingDepartmentBudgetMax":{"type":"integer","format":"int32","description":"Maximum marketing department budget amount in thousands (e.g., 1 = 1000, 500 = 500,000).  Minimum value is 0, maximum value is 2147483647 (approximately 2 trillion)."},"financeDepartmentBudgetMin":{"type":"integer","format":"int32","description":"Minimum finance department budget amount in thousands (e.g., 1 = 1000, 500 = 500,000).  Minimum value is 0, maximum value is 2147483647 (approximately 2 trillion)."},"financeDepartmentBudgetMax":{"type":"integer","format":"int32","description":"Maximum finance department budget amount in thousands (e.g., 1 = 1000, 500 = 500,000).  Minimum value is 0, maximum value is 2147483647 (approximately 2 trillion)."},"itDepartmentBudgetMin":{"type":"integer","format":"int32","description":"Minimum information technology department budget amount in thousands (e.g., 1 = 1000, 500 = 500,000).  Minimum value is 0, maximum value is 2147483647 (approximately 2 trillion)."},"itDepartmentBudgetMax":{"type":"integer","format":"int32","description":"Maximum information technology department budget amount in thousands (e.g., 1 = 1000, 500 = 500,000).  Minimum value is 0, maximum value is 2147483647 (approximately 2 trillion)."},"hrDepartmentBudgetMin":{"type":"integer","format":"int32","description":"Minimum human resources department budget amount in thousands (e.g., 1 = 1000, 500 = 500,000).  Minimum value is 0, maximum value is 2147483647 (approximately 2 trillion)."},"hrDepartmentBudgetMax":{"type":"integer","format":"int32","description":"Maximum human resources department budget amount in thousands (e.g., 1 = 1000, 500 = 500,000).  Minimum value is 0, maximum value is 2147483647 (approximately 2 trillion)."},"certified":{"type":"integer","format":"int32","description":"Denotes if ZoomInfo's research and data team has confirmed activity within the past 12 months. 1 = certified, 0 = not certified."},"excludeDefunctCompanies":{"type":"boolean","description":"Defaults to false. Set true to exclude defunct companies from results."},"businessModel":{"type":"array","items":{"type":"string"},"description":"Search using Business Model (B2C, B2B, B2G) for a company. Default is All."},"underManagement":{"type":"boolean","description":"Returns whether or not record is under management if set to true."},"companyTicker":{"type":"array","items":{"type":"string"},"description":"Company stock ticker symbol."},"companyDescription":{"type":"string","description":"Search for companies based on description. Accepts a space-separated list of individual words."},"companyType":{"type":"string","description":"Company type (private, public, etc.). Accepts a comma-separated list of types."},"address":{"type":"string","description":"Full Company Address."},"street":{"type":"string","description":"Street address portion of the company's location."},"state":{"type":"string","description":"State or province of the company's address."},"zipCode":{"type":"string","description":"Zip Code or Postal Code of the company's address."},"country":{"type":"string","description":"Country of the primary address of the associated company."},"continent":{"type":"string","description":"Continent of the primary address of the associated company."},"zipCodeRadiusMiles":{"type":"integer","format":"int16","description":"Used in conjunction with zipCode, designates a geographical radius (in miles) from the zipCode provided. Supported values are [10, 25, 50, 100, 250]"},"hashTagString":{"type":"string","description":"Hash tags for a company. Can include a comma-separated list."},"techAttributeTagList":{"type":"string","description":"Technology Product Tags. Can include a comma-separated list."},"primaryIndustriesOnly":{"type":"boolean","description":"Default is false. 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."},"subUnitTypes":{"type":"string","description":"Company sub types (e.g., division, subsidiary). Use this in conjunction with parentId or ultimateParentId."},"industryCodes":{"type":"string","description":"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."},"industryKeywords":{"type":"string","description":"Industry keywords associated with a company. Can include either 'AND' or 'OR' operators. For example, 'software AND security' or 'software OR security'"},"sicCodes":{"type":"string","description":"The Standard Industrial Classification is a system for classifying industries by a four-digit code numerical assigned by the U.S. government to business establishments to identify the primary business of the establishment. Accepts a comma-separated list."},"naicsCodes":{"type":"string","description":"Four-digit numerical codes assigned by the U.S. government to business establishments to identify the primary business of the establishment. Accepts a comma-separated list of values."},"revenue":{"type":"string","description":"Annual revenue range in U.S. dollars. Accepts a comma-separated list of values."},"revenueMin":{"type":"integer","format":"int32","description":"Minimum annual revenue for a company in U.S. dollars (expressed in thousands). Use with revenueMax to set a range."},"revenueMax":{"type":"integer","format":"int32","description":"Maximum annual revenue for a company in U.S. dollars (expressed in thousands). Use with revenueMin to set a range."},"employeeRangeMin":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"Employee count range. Accepts a comma-separated list of values. Alternatively, for more granular ranges, you can use the employeeRangeMin and employeeRangeMax parameters."},"companyRanking":{"type":"string","description":"Company ranking (e.g., Fortune 500). Accepts a comma-separated list of IDs."},"metroRegion":{"type":"string","description":"Company metro area. Accepts a comma-separated list of U.S. and Canada metro areas."},"locationSearchType":{"type":"string","description":"Location type (PersonOrHQ, PersonAndHQ, Person, HQ, PersonThenHQ)."},"fundingAmountMin":{"type":"integer","format":"int32","description":"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":{"type":"integer","format":"int32","description":"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":{"type":"string","format":"date","description":"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":{"type":"string","format":"date","description":"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."},"zoominfoContactsMin":{"type":"string","description":"Minimum number of ZoomInfo contacts associated with company."},"zoominfoContactsMax":{"type":"string","description":"Maximum number of ZoomInfo contacts associated with company."},"excludedRegions":{"type":"string","description":"Accepts a comma-separated list of U.S. and Canada states and metro areas. Companies from any of these regions will be excluded from search results."},"companyStructureIncludedSubUnitTypes":{"type":"string","description":"Company hierarchical structure values. Accepts a comma-separated list of values from 'UNSPECIFIED', 'LOCATION', 'DIVISION', 'ACQUISITION', 'SUBSIDIARY', 'FORMER_NEW_NAME'."},"oneYearEmployeeGrowthRateMin":{"type":"string","description":"Minimum one year employee growth rate for a company. Use with oneYearEmployeeGrowthRateMax to set a range."},"oneYearEmployeeGrowthRateMax":{"type":"string","description":"Maximum one year employee growth rate for a company. Use with oneYearEmployeeGrowthRateMin to set a range."},"twoYearEmployeeGrowthRateMin":{"type":"string","description":"Minimum two year employee growth rate for a company. Use with twoYearEmployeeGrowthRateMax to set a range."},"twoYearEmployeeGrowthRateMax":{"type":"string","description":"Maximum two year employee growth rate for a company. Use with twoYearEmployeeGrowthRateMin to set a range."},"parentId":{"type":"string","description":"ZoomInfo Company ID for parent company."},"ultimateParentId":{"type":"string","description":"Company sub types (e.g., division, subsidiary). Use this in conjunction with parentId or ultimateParentId."},"companyId":{"type":"string","description":"Unique ZoomInfo identifier for a company."},"companyName":{"type":"string","description":"Company name."},"companyWebsite":{"type":"string","description":"Company website URL in http://www.example.com format. Accepts a comma-separated list."},"engagementStartDate":{"type":"string","format":"date","description":"Engagement start date in YYYY-MM-DD format."},"engagementEndDate":{"type":"string","format":"date","description":"Engagement end date in YYYY-MM-DD format. EngagementStartDate is required."},"engagementType":{"type":"array","items":{"type":"string"},"description":"List of engagement types to search for. Accepted values are 'email', 'phone', 'online meeting'. Accepts a comma-separated list of these values."},"excludeTechAttributeTagList":{"type":"string","description":"Exclude companies with these technology product tags. String can be one value ('131315') or a comma-separated list which is treated as OR logic ('131315, 132222'). Individual values can also include AND logic ('131315 AND 131301, 132222'). This last example would be evaluated as ((131201 AND 131301) OR 132222)."}},"description":"Request attributes for company search."},"CompanySearchResource":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"The type of the resource","default":"CompanySearch","pattern":"CompanySearch"},"attributes":{"allOf":[{"$ref":"#/components/schemas/CompanySearchRequestAttributes"}],"description":"The attributes defining the resource"}},"description":"Company search request resource."},"CompanySearchRequest":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/CompanySearchResource"}],"description":"The primary data of the document"}},"description":"Company search request."},"IntentCompany":{"type":"object","properties":{"id":{"type":"string","description":"ZoomInfo unique identifier for the company."},"name":{"type":"string","description":"Company name."},"website":{"type":"string","description":"Company domain."},"hasOtherTopicConsumption":{"type":"boolean","description":"Indicates whether a company has other topics with increased consumption. Values are true and false."}},"description":"ZoomInfo Company"},"JobFunction":{"type":"object","properties":{"name":{"type":"string","description":"Name of the job function."},"department":{"type":"string","description":"Department associated with the job function."}},"description":"Contact job function at current place of employment."},"RecommendedContact":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Unique ZoomInfo identifier for the contact."},"firstName":{"type":"string","description":"Contact first name."},"lastName":{"type":"string","description":"Contact last name."},"jobTitle":{"type":"string","description":"Contact job title at current place of employment."},"companyName":{"type":"string","description":"Company name of the contact."},"jobFunctions":{"type":"array","items":{"$ref":"#/components/schemas/JobFunction"},"description":"Contact's job functions. This is an array of job functions that the contact holds or has held."}},"description":"Recommended contact for intent search response."},"IntentSearchResponseAttributes":{"type":"object","properties":{"category":{"type":"string","description":"Intent category."},"topic":{"type":"string","description":"Intent topic."},"signalScore":{"type":"integer","format":"int32","description":"Signal score for the topic."},"audienceStrength":{"type":"string","description":"Audience strength for the topic."},"signalDate":{"type":"string","format":"date-time","description":"Date the signal was identified."},"company":{"allOf":[{"$ref":"#/components/schemas/IntentCompany"}],"description":"Company data for the intent topic."},"recommendedContacts":{"type":"array","items":{"$ref":"#/components/schemas/RecommendedContact"},"description":"Suggested contacts at the company that are related to the intent topic."},"spikesInDateRange":{"type":"integer","format":"int32","description":"The total number of intent signals detected during your specified timeframe."}},"description":"Response attributes for intent search.","x-class-extra-annotation":"@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true)"},"IntentResponse":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"Intent","pattern":"Intent"},"attributes":{"allOf":[{"$ref":"#/components/schemas/IntentSearchResponseAttributes"}],"description":"The attributes defining the resource"}},"description":"ZoomInfo Intent"},"IntentSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/IntentResponse"},"description":"The primary data of the document"},"meta":{"allOf":[{"$ref":"#/components/schemas/ResultMeta"}],"description":"Non-standard meta information about the document"},"links":{"allOf":[{"$ref":"#/components/schemas/Links"}],"description":"Links related to the primary data"}},"description":"A list of intents that match the criteria specified in the request"},"IntentSearchRequestAttributes":{"type":"object","required":["topics"],"properties":{"topics":{"type":"array","items":{"type":"string"},"description":"Intent topics. Accepts an Array of up to 50 Strings. See the 'Intent Topics' Lookup endpoint for values."},"signalStartDate":{"type":"string","format":"date","description":"Start date for a company signaling interest in a topic. Uses YYYY-MM-DD format."},"signalEndDate":{"type":"string","format":"date","description":"End date for a company signaling interest in a topic. Uses YYYY-MM-DD format."},"signalScoreMin":{"type":"integer","format":"int32","description":"Minimum signal score. Use with signalScoreMax to form a range. Minimum score is 60 and maximum is 100."},"signalScoreMax":{"type":"integer","format":"int32","description":"Maximum signal score. Use with signalScoreMin to form a range. Minimum score is 60 and maximum is 100."},"audienceStrengthMin":{"type":"string","description":"Minimum audience strength score. Use with audienceStrengthMax to form a range. Values are A, B, C, D, and E, with A indicating a larger audience."},"audienceStrengthMax":{"type":"string","description":"Maximum audience strength score. Use with audienceStrengthMin to form a range. Values are A, B, C, D, and E, with A indicating a larger audience."},"findRecommendedContacts":{"type":"boolean","description":"Default is true. Set to false to exclude recommended contacts from results."},"businessModel":{"type":"array","items":{"type":"string"},"description":"Search using Business Model (B2C, B2B, B2G) for a company. Default is All."},"companyTicker":{"type":"array","items":{"type":"string"},"description":"Company stock ticker symbol."},"companyDescription":{"type":"string","description":"Search for companies based on description. Accepts a space-separated list of individual words."},"companyType":{"type":"string","description":"Company type (private, public, etc.). Accepts a comma-separated list of types."},"address":{"type":"string","description":"Full Company Address."},"street":{"type":"string","description":"Street address portion of the company's location."},"state":{"type":"string","description":"State or province of the company's address."},"zipCode":{"type":"string","description":"Zip Code or Postal Code of the company's address."},"country":{"type":"string","description":"Country of the primary address of the associated company."},"continent":{"type":"string","description":"Continent of the primary address of the associated company."},"zipCodeRadiusMiles":{"type":"integer","format":"int16","description":"Used in conjunction with zipCode, designates a geographical radius (in miles) from the zipCode provided. Supported values are [10, 25, 50, 100, 250]"},"hashTagString":{"type":"string","description":"Hash tags for a company. Can include a comma-separated list."},"techAttributeTagList":{"type":"string","description":"Technology Product Tags. Can include a comma-separated list."},"primaryIndustriesOnly":{"type":"boolean","description":"Default is false. 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."},"subUnitTypes":{"type":"string","description":"Company sub types (e.g., division, subsidiary). Use this in conjunction with parentId or ultimateParentId."},"industryCodes":{"type":"string","description":"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."},"industryKeywords":{"type":"string","description":"Industry keywords associated with a company. Can include either 'AND' or 'OR' operators. For example, 'software AND security' or 'software OR security'"},"sicCodes":{"type":"string","description":"The Standard Industrial Classification is a system for classifying industries by a four-digit code numerical assigned by the U.S. government to business establishments to identify the primary business of the establishment. Accepts a comma-separated list."},"naicsCodes":{"type":"string","description":"Four-digit numerical codes assigned by the U.S. government to business establishments to identify the primary business of the establishment. Accepts a comma-separated list of values."},"revenue":{"type":"string","description":"Annual revenue range in U.S. dollars. Accepts a comma-separated list of values."},"revenueMin":{"type":"integer","format":"int32","description":"Minimum annual revenue for a company in U.S. dollars (expressed in thousands). Use with revenueMax to set a range."},"revenueMax":{"type":"integer","format":"int32","description":"Maximum annual revenue for a company in U.S. dollars (expressed in thousands). Use with revenueMin to set a range."},"employeeRangeMin":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"Employee count range. Accepts a comma-separated list of values. Alternatively, for more granular ranges, you can use the employeeRangeMin and employeeRangeMax parameters."},"companyRanking":{"type":"string","description":"Company ranking (e.g., Fortune 500). Accepts a comma-separated list of IDs."},"metroRegion":{"type":"string","description":"Company metro area. Accepts a comma-separated list of U.S. and Canada metro areas."},"locationSearchType":{"type":"string","description":"Location type (PersonOrHQ, PersonAndHQ, Person, HQ, PersonThenHQ)."},"fundingAmountMin":{"type":"integer","format":"int32","description":"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":{"type":"integer","format":"int32","description":"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":{"type":"string","format":"date","description":"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":{"type":"string","format":"date","description":"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."},"zoominfoContactsMin":{"type":"string","description":"Minimum number of ZoomInfo contacts associated with company."},"zoominfoContactsMax":{"type":"string","description":"Maximum number of ZoomInfo contacts associated with company."},"excludedRegions":{"type":"string","description":"Accepts a comma-separated list of U.S. and Canada states and metro areas. Companies from any of these regions will be excluded from search results."},"companyStructureIncludedSubUnitTypes":{"type":"string","description":"Company hierarchical structure values. Accepts a comma-separated list of values from 'UNSPECIFIED', 'LOCATION', 'DIVISION', 'ACQUISITION', 'SUBSIDIARY', 'FORMER_NEW_NAME'."},"oneYearEmployeeGrowthRateMin":{"type":"string","description":"Minimum one year employee growth rate for a company. Use with oneYearEmployeeGrowthRateMax to set a range."},"oneYearEmployeeGrowthRateMax":{"type":"string","description":"Maximum one year employee growth rate for a company. Use with oneYearEmployeeGrowthRateMin to set a range."},"twoYearEmployeeGrowthRateMin":{"type":"string","description":"Minimum two year employee growth rate for a company. Use with twoYearEmployeeGrowthRateMax to set a range."},"twoYearEmployeeGrowthRateMax":{"type":"string","description":"Maximum two year employee growth rate for a company. Use with twoYearEmployeeGrowthRateMin to set a range."}},"description":"Request Attributes for intent search."},"IntentSearchResource":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"The type of the resource","default":"IntentSearch","pattern":"IntentSearch"},"attributes":{"allOf":[{"$ref":"#/components/schemas/IntentSearchRequestAttributes"}],"description":"The attributes defining the resource"}},"description":"Intent search request resource."},"IntentSearchRequest":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/IntentSearchResource"}],"description":"The primary data of the document"}},"description":"Intent search request."},"NewsCompany":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique ZoomInfo identifier for the company."},"name":{"type":"string","description":"Company name."}},"description":"Company related to the news article."},"NewsResponseAttributes":{"type":"object","properties":{"domain":{"type":"string","description":"Domain name of the news source."},"title":{"type":"string","description":"Title of the news article."},"url":{"type":"string","description":"Full URL of the article."},"imageUrl":{"type":"string","description":"URL of the article image."},"pageDate":{"type":"string","format":"date-time","description":"Publish date of the article."},"categories":{"type":"array","items":{"type":"string"},"description":"Categories assigned to the article."},"description":{"type":"string","description":"Summary or body of the article."},"company":{"type":"array","items":{"$ref":"#/components/schemas/NewsCompany"},"description":"Companies mentioned in the article."}},"description":"Attributes of a single news result."},"NewsResponse":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"News","pattern":"News"},"attributes":{"allOf":[{"$ref":"#/components/schemas/NewsResponseAttributes"}],"description":"The attributes defining the resource"}},"description":"News"},"NewsSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NewsResponse"},"description":"The primary data of the document"},"meta":{"allOf":[{"$ref":"#/components/schemas/ResultMeta"}],"description":"Non-standard meta information about the document"},"links":{"allOf":[{"$ref":"#/components/schemas/Links"}],"description":"Links related to the primary data"}},"description":"A list of News that match the criteria specified in the request"},"NewsRequestAttributes":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"string"},"description":"Category of news articles. Accepts an Array of String. See the 'News Categories' lookup endpoint for values."},"url":{"type":"array","items":{"type":"string"},"description":"News URL strings. Accepts an Array of String. Minimum of 5 characters per input"},"pageDateMin":{"type":"string","format":"date","description":"Specify the earliest publishing date for news articles returned. Uses YYYY-MM-DD format (e.g., 2020-01-01 will return all news articles published on or after Jan 1, 2020)."},"pageDateMax":{"type":"string","format":"date","description":"Specify the latest publishing date for news articles articles. Uses YYYY-MM-DD format (e.g., 2020-01-31 will return all new articles published on or before Jan 31, 2020)."}},"description":"Request attributes for news."},"NewsSearchResource":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"The type of the resource","default":"NewsSearch","pattern":"NewsSearch"},"attributes":{"allOf":[{"$ref":"#/components/schemas/NewsRequestAttributes"}],"description":"The attributes defining the resource"}},"description":"News search request resource."},"NewsSearchRequest":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/NewsSearchResource"}],"description":"The primary data of the document"}},"description":"News search request."},"ScoopCompany":{"type":"object","properties":{"id":{"type":"string","description":"Unique ZoomInfo identifier for a company."},"name":{"type":"string","description":"Company name."}},"description":"ScoopCompany"},"ScoopContact":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Unique ZoomInfo identifier for a person."},"firstName":{"type":"string","description":"Contact first name."},"lastName":{"type":"string","description":"Contact last name."},"jobTitle":{"type":"string","description":"Contact job title at current place of employment."},"jobFunction":{"type":"array","items":{"$ref":"#/components/schemas/JobFunction"},"description":"Contact job function at their current place of employment."}},"description":"ScoopContact"},"ScoopSearchResponseAttributes":{"type":"object","properties":{"id":{"type":"string","description":"ZoomInfo unique identifier for a scoop."},"publishedDate":{"type":"string","format":"date-time","description":"Date when a scoop was published."},"originalPublishedDate":{"type":"string","format":"date-time","description":"Date when a scoop was originally published."},"linkText":{"type":"string","description":"Link text for a scoop."},"link":{"type":"string","description":"URL for a scoop."},"description":{"type":"string","description":"Description associated with the scoop"},"topics":{"type":"array","items":{"type":"object","additionalProperties":{}},"description":"Scoop topics."},"updateText":{"type":"string","description":"Text related to an updated scoop."},"types":{"type":"array","items":{"type":"object","additionalProperties":{}},"description":"Types associated with a scoop."},"company":{"allOf":[{"$ref":"#/components/schemas/ScoopCompany"}],"description":"Company"},"contacts":{"type":"array","items":{"$ref":"#/components/schemas/ScoopContact"},"description":"Contacts associated with a scoop."}},"description":"Scoop search response attributes."},"ScoopResponse":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"Scoop","pattern":"Scoop"},"attributes":{"allOf":[{"$ref":"#/components/schemas/ScoopSearchResponseAttributes"}],"description":"The attributes defining the resource"}},"description":"News"},"ScoopSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ScoopResponse"},"description":"The primary data of the document"},"meta":{"allOf":[{"$ref":"#/components/schemas/ResultMeta"}],"description":"Non-standard meta information about the document"},"links":{"allOf":[{"$ref":"#/components/schemas/Links"}],"description":"Links related to the primary data"}},"description":"A list of News that match the criteria specified in the request"},"ScoopSearchRequestAttributes":{"type":"object","properties":{"publishedStartDate":{"type":"string","format":"date","description":"Starting date to search for scoops based on publication date. Form a range using publishedEndDate or omit publishedEndDate to search to the current date. Uses YYYY-MM-DD format."},"publishedEndDate":{"type":"string","format":"date","description":"Ending date to search for scoops based on publication date. Form a range using publishedStartDate. Uses YYYY-MM-DD format."},"updatedSinceCreation":{"type":"boolean","description":"Default is false. Setting true will only return scoops that have been updated since publishedStartDate."},"scoopType":{"type":"string","description":"Retrieve scoops based on type (e.g. earnings, awards and partnerships). Accepts a comma-separated list of IDs from the lookup endpoint."},"scoopTopic":{"type":"string","description":"Retrieve scoops based on topic (e.g. integration, consolidation and compliance). Accepts a comma-separated list of IDs from the lookup endpoint."},"department":{"type":"string","description":"Retrieve scoops based on department (IT, finance, HR and so on). See the Scoop Departments lookup endpoint for valid inputs.."},"scoopId":{"type":"string","description":"ZoomInfo unique identifier for a Scoop. Accepts a comma-separated list."},"description":{"type":"string","description":"Search for scoops based on description.  Accepts a space-separated list of individual words."},"businessModel":{"type":"array","items":{"type":"string"},"description":"Search using Business Model (B2C, B2B, B2G) for a company. Default is All."},"personId":{"type":"string","description":"Unique ZoomInfo identifier for the contact. Can include a comma-separated list."},"emailAddress":{"type":"string","description":"Email address for the contact in example@example.com format."},"hashedEmail":{"type":"string","description":"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."},"fullName":{"type":"string","description":"Contact full name."},"firstName":{"type":"string","description":"Contact first name."},"middleInitial":{"type":"string","description":"Contact middle initial."},"lastName":{"type":"string","description":"Contact last name."},"jobTitle":{"type":"string","description":"Contact job title at current place of employment."},"exactJobTitle":{"type":"string","description":"Contact title at current place of employment using exact match logic. Use OR to input multiple job titles."},"excludeJobTitle":{"type":"string","description":"Comma-separated list of job titles to exclude from search results."},"managementLevel":{"type":"string","description":"Contact management level at current place of employment."},"excludeManagementLevel":{"type":"string","description":"Comma separated list of management levels to exclude from search results."},"boardMember":{"type":"string","description":"Exclude or include board members from search results. Default behavior is to exclude board members from search results. Submit this as “include” to include board members, set this as “only” to only include board members.."},"excludePartialProfiles":{"type":"boolean","description":"Defaults to false. To include partial profiles in your search results, set this to true. Contacts who do not have an active company associated with them are considered partial profiles."},"executivesOnly":{"type":"boolean","description":"Defaults to false. Set this to true to include only Executives in search results."},"requiredFields":{"type":"string","description":"Specify the fields that must be present for a record to return. Accepts a comma-separated list."},"contactAccuracyScoreMin":{"type":"string","description":"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."},"contactAccuracyScoreMax":{"type":"string","description":"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."},"jobFunction":{"type":"string","description":"Contact job function at their current place of employment."},"lastUpdatedInMonths":{"type":"integer","format":"int32","description":"Number of months within which the contact's profile was last updated."},"hasBeenNotified":{"type":"string","description":"Defaults to include. Set this to “exclude” to exclude contacts who have been notified of inclusion in ZoomInfo's database. Set this to “only” to only include contacts who have been notified."},"companyPastOrPresent":{"type":"string","description":"Defaults to only include the present company for a contact. Set this to “past” to return past companies, set this to “pastAndPresent” to include both."},"school":{"type":"string","description":"School name."},"degree":{"type":"string","description":"Searches by contact's education."},"locationCompanyId":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Searches by contact's locationIds."},"certified":{"type":"integer","format":"int32","description":"Denotes if ZoomInfo's research and data team has confirmed activity within the past 12 months. 1 = certified, 0 = not certified."},"companyTicker":{"type":"array","items":{"type":"string"},"description":"Company stock ticker symbol."},"companyDescription":{"type":"string","description":"Search for companies based on description. Accepts a space-separated list of individual words."},"companyType":{"type":"string","description":"Company type (private, public, etc.). Accepts a comma-separated list of types."},"address":{"type":"string","description":"Full Company Address."},"street":{"type":"string","description":"Street address portion of the company's location."},"state":{"type":"string","description":"State or province of the company's address."},"zipCode":{"type":"string","description":"Zip Code or Postal Code of the company's address."},"country":{"type":"string","description":"Country of the primary address of the associated company."},"continent":{"type":"string","description":"Continent of the primary address of the associated company."},"zipCodeRadiusMiles":{"type":"integer","format":"int16","description":"Used in conjunction with zipCode, designates a geographical radius (in miles) from the zipCode provided. Supported values are [10, 25, 50, 100, 250]"},"hashTagString":{"type":"string","description":"Hash tags for a company. Can include a comma-separated list."},"techAttributeTagList":{"type":"string","description":"Technology Product Tags. Can include a comma-separated list."},"primaryIndustriesOnly":{"type":"boolean","description":"Default is false. 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."},"subUnitTypes":{"type":"string","description":"Company sub types (e.g., division, subsidiary). Use this in conjunction with parentId or ultimateParentId."},"industryCodes":{"type":"string","description":"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."},"industryKeywords":{"type":"string","description":"Industry keywords associated with a company. Can include either 'AND' or 'OR' operators. For example, 'software AND security' or 'software OR security'"},"sicCodes":{"type":"string","description":"The Standard Industrial Classification is a system for classifying industries by a four-digit code numerical assigned by the U.S. government to business establishments to identify the primary business of the establishment. Accepts a comma-separated list."},"naicsCodes":{"type":"string","description":"Four-digit numerical codes assigned by the U.S. government to business establishments to identify the primary business of the establishment. Accepts a comma-separated list of values."},"revenue":{"type":"string","description":"Annual revenue range in U.S. dollars. Accepts a comma-separated list of values."},"revenueMin":{"type":"integer","format":"int32","description":"Minimum annual revenue for a company in U.S. dollars (expressed in thousands). Use with revenueMax to set a range."},"revenueMax":{"type":"integer","format":"int32","description":"Maximum annual revenue for a company in U.S. dollars (expressed in thousands). Use with revenueMin to set a range."},"employeeRangeMin":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"Employee count range. Accepts a comma-separated list of values. Alternatively, for more granular ranges, you can use the employeeRangeMin and employeeRangeMax parameters."},"companyRanking":{"type":"string","description":"Company ranking (e.g., Fortune 500). Accepts a comma-separated list of IDs."},"metroRegion":{"type":"string","description":"Company metro area. Accepts a comma-separated list of U.S. and Canada metro areas."},"locationSearchType":{"type":"string","description":"Location type (PersonOrHQ, PersonAndHQ, Person, HQ, PersonThenHQ)."},"fundingAmountMin":{"type":"integer","format":"int32","description":"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":{"type":"integer","format":"int32","description":"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":{"type":"string","format":"date","description":"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":{"type":"string","format":"date","description":"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."},"zoominfoContactsMin":{"type":"string","description":"Minimum number of ZoomInfo contacts associated with company."},"zoominfoContactsMax":{"type":"string","description":"Maximum number of ZoomInfo contacts associated with company."},"excludedRegions":{"type":"string","description":"Accepts a comma-separated list of U.S. and Canada states and metro areas. Companies from any of these regions will be excluded from search results."},"companyStructureIncludedSubUnitTypes":{"type":"string","description":"Company hierarchical structure values. Accepts a comma-separated list of values from 'UNSPECIFIED', 'LOCATION', 'DIVISION', 'ACQUISITION', 'SUBSIDIARY', 'FORMER_NEW_NAME'."},"oneYearEmployeeGrowthRateMin":{"type":"string","description":"Minimum one year employee growth rate for a company. Use with oneYearEmployeeGrowthRateMax to set a range."},"oneYearEmployeeGrowthRateMax":{"type":"string","description":"Maximum one year employee growth rate for a company. Use with oneYearEmployeeGrowthRateMin to set a range."},"twoYearEmployeeGrowthRateMin":{"type":"string","description":"Minimum two year employee growth rate for a company. Use with twoYearEmployeeGrowthRateMax to set a range."},"twoYearEmployeeGrowthRateMax":{"type":"string","description":"Maximum two year employee growth rate for a company. Use with twoYearEmployeeGrowthRateMin to set a range."}},"description":"Scoop search request attributes."},"ScoopSearchResource":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"The type of the resource","default":"ScoopSearch","pattern":"ScoopSearch"},"attributes":{"allOf":[{"$ref":"#/components/schemas/ScoopSearchRequestAttributes"}],"description":"The attributes defining the resource"}},"description":"Scoop search request resource."},"ScoopSearchRequest":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/ScoopSearchResource"}],"description":"The primary data of the document"}},"description":"News search request."},"EducationDegree":{"type":"object","properties":{"degree":{"type":"string","description":"Degree type (e.g., Bachelor of Science, Master of Arts, Doctor of Philosophy)."},"areaOfStudy":{"type":"string","description":"Area of study for the degree (e.g., Computer Science, Business Administration, Economics)."}},"description":"Education degree for match"},"Education":{"type":"object","properties":{"school":{"type":"string","description":"School name."},"educationDegree":{"allOf":[{"$ref":"#/components/schemas/EducationDegree"}],"description":"School type (e.g., High School, College, University)."}},"description":"Contact education details."},"TechSkill":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the technology skill."},"name":{"type":"string","description":"Name of the technology skill."}},"description":"Technology skill identified for a contact."},"ContactDataWithSource":{"type":"object","properties":{"value":{"type":"string","description":"The phone number or email address value."},"source":{"type":"string","description":"The source identifier indicating which data source provided this value."}},"description":"Alternative phone number or email with its source identifier."},"ExternalUrl":{"type":"object","properties":{"type":{"type":"string","description":"Type of social media account (e.g., Facebook, Twitter, LinkedIn)."},"url":{"type":"string","description":"URL for the social media account."}},"description":"Social media URLs for the contact (e.g., Facebook, Twitter, LinkedIn)."},"EmploymentCompany":{"type":"object","properties":{"companyId":{"type":"integer","format":"int64","description":"Unique ZoomInfo identifier for a company."},"companyName":{"type":"string","description":"Company name."},"companyPhone":{"type":"string","description":"Company phone."},"companyWebsite":{"type":"string","description":"Company website URL in http://www.example.com format."}},"description":"Company for match."},"EmploymentHistory":{"type":"object","properties":{"jobTitle":{"type":"string","description":"Contact title at current place of employment"},"managementLevel":{"type":"array","items":{"type":"string"},"description":"Contact management level"},"fromDate":{"type":"string","format":"date","description":"Start date for this employment. Uses YYYY-MM-DD format."},"toDate":{"type":"string","format":"date","description":"End date for this employment. Uses YYYY-MM-DD format."},"company":{"allOf":[{"$ref":"#/components/schemas/EmploymentCompany"}],"description":"Company for employment"}},"description":"Contact employment history"},"Engagement":{"type":"object","properties":{"engagementDate":{"type":"string","format":"date-time","description":"Date of engagement."},"engagementType":{"type":"string","description":"Type of engagement."}},"description":"Engagement details."},"SocialMediaUrl":{"type":"object","properties":{"type":{"type":"string","description":"Type of social media account. Supported types are Facebook, Twitter (X.com), LinkedIn)."},"url":{"type":"string","description":"URL for the social media account."},"followerCount":{"type":"string","description":"Number of followers for the social media account."}},"description":"Social media information for the company."},"PrimaryIndustryCode":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the industry code."},"name":{"type":"string","description":"Name of the industry code."}},"description":"Top-level industry for a company along with its code."},"PrimarySubIndustryCode":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the sub-industry code."},"name":{"type":"string","description":"Name of the sub-industry code."}},"description":"Top-level sub-industry for a company along with its code."},"IndustryCode":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the industry code."},"name":{"type":"string","description":"Name of the industry code."}},"description":"The industry grouping for the company along with it's codes. A company can have multiple industries."},"SicCode":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the SIC code."},"name":{"type":"string","description":"Name of the SIC code."}},"description":"The Standard Industrial Classification is a system for classifying industries by a four-digit code."},"NaicsCode":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the NAICS code."},"name":{"type":"string","description":"Name of the NAICS code."}},"description":"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."},"EmployeeGrowthDataPoint":{"type":"object","properties":{"label":{"type":"string","description":"Label for the data point (e.g., '21 - Q1')."},"employeeCount":{"type":"integer","format":"int64","description":"Total employee count for the data point."}},"description":"Quarter-by-quarter breakdown of total employee count."},"EmployeeGrowth":{"type":"object","properties":{"oneYearGrowthRate":{"type":"string","description":"One-year growth rate."},"twoYearGrowthRate":{"type":"string","description":"Two-year growth rate."},"employeeGrowthDataPoints":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeGrowthDataPoint"},"description":"Quarter-by-quarter breakdown of total employee count."}},"description":"Employee growth of the company in the past two years. A one- and two-year growth percentage is provided as well as a quarter-by-quarter breakdown of total employee count."},"ContactCompanyEnrich":{"type":"object","properties":{"socialMediaUrls":{"type":"array","items":{"$ref":"#/components/schemas/SocialMediaUrl"},"description":"Social media URLs for the company (e.g., Facebook, Twitter, LinkedIn and so on)."},"primaryIndustry":{"type":"array","items":{"type":"string"},"description":"Top-level industry for a company."},"primaryIndustryCode":{"type":"array","items":{"$ref":"#/components/schemas/PrimaryIndustryCode"},"description":"Top-level industry for a company along with its code."},"primarySubIndustryCode":{"type":"array","items":{"$ref":"#/components/schemas/PrimarySubIndustryCode"},"description":"Top-level sub-industry for a company along with its code."},"industries":{"type":"array","items":{"type":"string"},"description":"The industry grouping for the company. A company can have multiple industries."},"industryCodes":{"type":"array","items":{"$ref":"#/components/schemas/IndustryCode"},"description":"The industry grouping for the company along with it's codes. A company can have multiple industries."},"website":{"type":"string","description":"Company website."},"type":{"type":"string","description":"Company type (private, public, npo, education, government, other)."},"ticker":{"type":"string","description":"Company public stock exchange ticker."},"name":{"type":"string","description":"Company name."},"description":{"type":"string","description":"Description associated with the company."},"phone":{"type":"string","description":"Company phone number."},"fax":{"type":"string","description":"Fax number of the company headquarters."},"street":{"type":"string","description":"Street portion of the company's primary address."},"city":{"type":"string","description":"City of the company's primary address."},"state":{"type":"string","description":"State or province of the company's primary address."},"zipCode":{"type":"string","description":"Zip code or postal code of the company's primary address."},"country":{"type":"string","description":"Country of the company's primary address."},"continent":{"type":"string","description":"Continent of the company's primary address."},"logo":{"type":"string","description":"The URL which can be used to retrieve the logo for the company."},"alternateLogos":{"type":"array","items":{"type":"string"},"description":"List of alternate logos for the company."},"employeeCount":{"type":"integer","format":"int32","description":"Employee count of the company."},"sicCodes":{"type":"array","items":{"$ref":"#/components/schemas/SicCode"},"description":"The Standard Industrial Classification is a system for classifying industries by a four-digit numerical code assigned by the U.S. government to business establishments to identify the primary business of the establishment."},"naicsCodes":{"type":"array","items":{"$ref":"#/components/schemas/NaicsCode"},"description":"Four-digit numerical codes assigned by the U.S. government to business establishments to identify the primary business of the establishment."},"employeeRange":{"type":"string","description":"Employee range at the company."},"employeeGrowth":{"allOf":[{"$ref":"#/components/schemas/EmployeeGrowth"}],"description":"Employee growth rate at the company."},"revenueRange":{"type":"string","description":"Revenue range for a company."},"id":{"type":"integer","format":"int64","description":"Unique ZoomInfo ID"},"revenue":{"type":"string","description":"Company revenue (e.g., 400 Million)."},"revenueNumeric":{"type":"integer","format":"int64","description":"Company revenue expressed numerically (e.g. 400000000)."},"ranking":{"type":"array","items":{"type":"string"},"description":"Company ranking list (e.g., Fortune 500 and so on)."},"division":{"type":"string","description":"Contact primary division name at current place of employment."}},"description":"Contact's company data for an enrich request."},"ContactEnrichResponseAttributes":{"type":"object","properties":{"firstName":{"type":"string","description":"Contact first name."},"middleName":{"type":"string","description":"Contact middle name."},"lastName":{"type":"string","description":"Contact last name."},"email":{"type":"string","description":"Work email address for the contact in example@example.com format."},"hasCanadianEmail":{"type":"boolean","description":"Indicates whether the contact's email address is associated with a Canada domain."},"supplementalEmail":{"type":"string","description":"Supplemental email address for the contact in example@example.com format."},"phone":{"type":"string","description":"Contact direct phone number."},"directPhoneDoNotCall":{"type":"boolean","description":"Contact flagged with do not call for direct phone."},"street":{"type":"string","description":"Street portion of the contact's work address."},"city":{"type":"string","description":"City portion of the contact's work address."},"region":{"type":"string","description":"State or province of the contact's work address."},"metroArea":{"type":"string","description":"Metro area of the contact's work address."},"zipCode":{"type":"string","description":"Zip code or postal code of the contact's work address."},"state":{"type":"string","description":"State or province of the contact's work address."},"country":{"type":"string","description":"Country of the contact's work address."},"continent":{"type":"string","description":"Continent of the contact's work address."},"personHasMoved":{"type":"string","description":"Indicates ZoomInfo recognizes the contact does not match ZoomInfo's current company but does match known employment history."},"withinEu":{"type":"boolean","description":"Indicates whether the contact's work address is in Europe."},"withinCalifornia":{"type":"boolean","description":"Indicates whether the contact's work address is in California."},"withinCanada":{"type":"boolean","description":"Indicates whether the contact's work address is in Canada."},"validDate":{"type":"string","format":"date-time","description":"Date on which the contact record was last validated."},"lastUpdatedDate":{"type":"string","format":"date-time","description":"Date on which the contact record was last updated."},"noticeProvidedDate":{"type":"string","format":"date","description":"Date on which the contact was notified of inclusion in ZoomInfo's database. Uses YYYY-MM-DD format."},"salutation":{"type":"string","description":"Contact salutation."},"suffix":{"type":"string","description":"Contact suffix."},"jobTitle":{"type":"string","description":"Contact job title at current place of employment."},"jobFunction":{"allOf":[{"$ref":"#/components/schemas/JobFunction"}],"description":"Contact job function at current place of employment."},"education":{"type":"array","items":{"$ref":"#/components/schemas/Education"},"description":"Contact education details."},"hashedEmails":{"type":"array","items":{"type":"string"},"description":"Contact MD5 encrypted email address(es)."},"picture":{"type":"string","description":"The URL which can be used to retrieve a photo for the contact."},"techSkills":{"type":"array","items":{"$ref":"#/components/schemas/TechSkill"},"description":"List of technology skills identified for a contact."},"mobilePhone":{"type":"string","description":"Contact mobile phone."},"mobilePhoneDoNotCall":{"type":"boolean","description":"Contact flagged with do not call for mobile phone."},"directPhoneAlt":{"type":"array","items":{"$ref":"#/components/schemas/ContactDataWithSource"},"description":"Alternative direct phone numbers with their sources, providing multiple direct phone options from different data sources."},"mobilePhoneAlt":{"type":"array","items":{"$ref":"#/components/schemas/ContactDataWithSource"},"description":"Alternative mobile phone numbers with their sources, providing multiple mobile phone options from different data sources."},"emailAlt":{"type":"array","items":{"$ref":"#/components/schemas/ContactDataWithSource"},"description":"Alternative email addresses with their sources, providing multiple email options from different data sources."},"externalUrls":{"type":"array","items":{"$ref":"#/components/schemas/ExternalUrl"},"description":"Social media URLs for the contact (e.g., Facebook, Twitter, LinkedIn)."},"contactAccuracyScore":{"type":"string","description":"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."},"isDefunct":{"type":"boolean","description":"Indicates whether the company associated with the contact still exists."},"employmentHistory":{"type":"array","items":{"$ref":"#/components/schemas/EmploymentHistory"},"description":"Contact employment history."},"managementLevel":{"type":"array","items":{"type":"string"},"description":"Contact management level."},"locationCompanyId":{"type":"integer","format":"int64","description":"Company Id of contact's company."},"positionStartDate":{"type":"string","format":"date-time","description":"The date on which the contact began their current employment."},"yearsOfExperience":{"type":"string","description":"Years of overall experience."},"engagements":{"type":"array","items":{"$ref":"#/components/schemas/Engagement"},"description":"List of the contact's engagements. Includes the date and type of each engagement."},"company":{"allOf":[{"$ref":"#/components/schemas/ContactCompanyEnrich"}],"description":"Contact's company data."}},"description":"Contact enrich response attributes.","x-class-extra-annotation":"@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true)"},"ContactMatchStatus":{"type":"string","enum":["FULL_MATCH","NO_MATCH","NON_MATCH_BY_LAST_UPDATED_DATE","NON_MATCH_BY_VALID_DATE","NON_MATCH_BY_REQUIRED_FIELDS","NON_MATCH_BY_CONTACT_ACCURACY_MIN","COMPANY_ONLY_MATCH","CONTACT_ONLY_MATCH","OPT_OUT","LIMIT_EXCEEDED","INVALID_INPUT"],"description":"Match status indicating the result of an enrich request.","x-enumDescriptions":{"FULL_MATCH":"Match status indicating a full match with all criteria met.","NO_MATCH":"Match status indicating no match found.","LAST_UPDATE_NOT_MATCHED":"Match status indicating no match. Contact's last updated date is before requested date for field lastUpdatedDateAfter.","VALID_DATE_NOT_MATCHED":"Match status indicating no match. Contact's valid date is before requested date for field validDateAfter.","REQUIRED_FIELDS_MISSING":"Match status indicating no match. Required fields data for the enrich request are missing.","CONTACT_ACCURACY_NOT_MATCHED":"Match status indicating no match. Contact's contact accuracy score is below the requested minimum for field contactAccuracyScoreMin.","COMPANY_MATCH_ONLY":"Match status indicating a match with company data only.","CONTACT_MATCH_ONLY":"Match status indicating a match with contact data only.","CONTACT_OPTED_OUT":"Match status indicating the contact has opted out of ZoomInfo's data collection.","LIMIT_EXCEEDED":"Match status indicating the enrich request credit limit has been exceeded.","INPUT_ERROR":"Match status indicating an error with the input data."}},"ContactEnrichRequestCriteria":{"type":"object","properties":{"personId":{"type":"integer","format":"int64","description":"Unique ZoomInfo identifier for the contact."},"fullName":{"type":"string","description":"Contact full name."},"firstName":{"type":"string","description":"Contact first name."},"lastName":{"type":"string","description":"Contact last name."},"emailAddress":{"type":"string","description":"Email address for the contact in example@example.com format."},"phone":{"type":"string","description":"Contact direct or mobile phone number."},"jobTitle":{"type":"string","description":"Contact title at current place of employment."},"hashedEmail":{"type":"string","description":"Hashed email value for the contact. Allows matching via an email address with the extra security of not exposing the email. Supported hash algorithms are: MD5, SHA1, SHA256 and SHA512."},"externalURL":{"type":"string","description":"Social media URLs for the contact (e.g., Facebook, Twitter, LinkedIn)."},"lastUpdatedDateAfter":{"type":"string","format":"date","description":"The date after which the contact's profile was last updated. Uses YYYY-MM-DD format."},"validDateAfter":{"type":"string","format":"date","description":"The date after which the contact's profile was last validated. Uses YYYY-MM-DD format."},"contactAccuracyScoreMin":{"type":"string","description":"Minimum accuracy score for enrich result. 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."},"companyId":{"type":"integer","format":"int64","description":"Unique ZoomInfo identifier for a company."},"companyName":{"type":"string","description":"Company name."}},"description":"The Enrich API provides the ability to enrich contact and company data with ZoomInfo's proprietary data."},"Warning":{"type":"object","properties":{"code":{"type":"string","description":"Warning code."},"message":{"type":"string","description":"Warning message."},"fields":{"type":"array","items":{"type":"string"},"description":"Fields associated with the warning."}},"description":"Warning details for validation issues."},"ContactAttributeMeta":{"type":"object","required":["matchStatus","input"],"properties":{"matchStatus":{"allOf":[{"$ref":"#/components/schemas/ContactMatchStatus"}],"description":"The match status for the contact enrich operation, indicating whether a match was found and the type of match."},"input":{"allOf":[{"$ref":"#/components/schemas/ContactEnrichRequestCriteria"}],"description":"The input criteria that was used to perform the contact enrich match. This provides traceability for the match result."},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/Warning"},"description":"Details about any warnings encountered during the validation of the enrich request input criteria."}},"description":"Metadata describing the result of a contact enrich match, including the match status and the input criteria used for the match. Used to provide additional context about how the contact enrich response was determined."},"EnrichContact":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"Contact","pattern":"Contact"},"attributes":{"allOf":[{"$ref":"#/components/schemas/ContactEnrichResponseAttributes"}],"description":"The attributes defining the resource"},"meta":{"allOf":[{"$ref":"#/components/schemas/ContactAttributeMeta"}],"description":"Non-standard meta information about the resource"}},"description":"A matching contact was identified from the provided input data. This result could be either a FULL_MATCH (where both the company and contact information matched), a CONTACT_ONLY_MATCH (only the contact information provided matched and only contact fields requested are returned), or a COMPANY_ONLY_MATCH (only the company information provided matched and only the company fields requested are returned). The match status can be found within the meta object to determine which case was met."},"NoMatchContact":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"The unique identifier of the resource"},"type":{"type":"string","description":"The type identifier of the resource","default":"NoMatch","pattern":"NoMatch"},"meta":{"allOf":[{"$ref":"#/components/schemas/ContactAttributeMeta"}],"description":"Non-standard meta information about the resource"}},"description":"There was not a matching contact found for the provided input or is been filtered out because either of match statues - NON_MATCH_BY_LAST_UPDATED_DATE (Contact's last updated date is before requested date for field lastUpdatedDateAfter), NON_MATCH_BY_VALID_DATE (Contact's valid date is before requested date for field validDateAfter), NON_MATCH_BY_REQUIRED_FIELDS (Required fields data for the enrich request are missing), NON_MATCH_BY_CONTACT_ACCURACY_MIN (Contact's contact accuracy score is below the requested minimum for field contactAccuracyScoreMin), OPT_OUT (Contact has opted out of ZoomInfo's data collection), LIMIT_EXCEEDED (User credit limit has been exceeded). Exact details can be found within the meta object including the match status and other accompanying metadata."},"ContactEnrichResponseResourceUnion":{"type":"object","oneOf":[{"$ref":"#/components/schemas/EnrichContact"},{"$ref":"#/components/schemas/NoMatchContact"}],"discriminator":{"propertyName":"type","mapping":{"Contact":"#/components/schemas/EnrichContact","NoMatch":"#/components/schemas/NoMatchContact"}},"description":"Represents the possible resource types returned in a contact enrich response, including both a successful contact match and a no-match result. Used to encapsulate the response resource for contact enrichment."},"ContactEnrichResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ContactEnrichResponseResourceUnion"},"description":"The primary data of the document"}},"description":"Contact enrich response."},"ContactEnrichRequestAttributes":{"type":"object","required":["outputFields","matchPersonInput"],"properties":{"outputFields":{"type":"array","items":{"type":"string","enum":["city","companyAlternateLogos","companyCity","companyContinent","companyCountry","companyDescription","companyDivision","companyEmployeeCount","companyEmployeeGrowth","companyEmployeeRange","companyFax","companyId","companyIndustries","companyIndustryCodes","companyLogo","companyNaicsCodes","companyName","companyPhone","companyPrimaryIndustry","companyPrimaryIndustryCode","companyPrimarySubIndustryCode","companyRanking","companyRevenue","companyRevenueNumeric","companyRevenueRange","companySicCodes","companySocialMediaUrls","companyState","companyStreet","companyTicker","companyType","companyWebsite","companyZipCode","contactAccuracyScore","continent","country","directPhoneAlt","directPhoneDoNotCall","education","email","emailAlt","employmentHistory","engagements","externalUrls","firstName","hasCanadianEmail","hashedEmails","id","isDefunct","jobFunction","jobTitle","lastName","lastUpdatedDate","locationCompanyId","managementLevel","metroArea","middleName","mobilePhone","mobilePhoneAlt","mobilePhoneDoNotCall","noticeProvidedDate","personHasMoved","phone","picture","positionStartDate","region","salutation","state","street","suffix","supplementalEmail","techSkills","validDate","withinCalifornia","withinCanada","withinEu","yearsOfExperience","zipCode"]},"description":"Specifies the fields to include in the response. To request company-related fields for a contact, use camel-case field names corresponding to the company object (e.g., companyName, companyPhone, companyId, companyRevenue)."},"requiredFields":{"type":"array","items":{"type":"string"},"description":"List of fields that are required for the match."},"matchPersonInput":{"type":"array","items":{"$ref":"#/components/schemas/ContactEnrichRequestCriteria"},"minItems":1,"maxItems":25,"description":"List of matchPersonInput."}},"description":"Contact enrich request attributes."},"ContactEnrichRequestResource":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"The type of the resource","default":"ContactEnrich","pattern":"ContactEnrich"},"attributes":{"allOf":[{"$ref":"#/components/schemas/ContactEnrichRequestAttributes"}],"description":"The attributes defining the resource"}},"description":"Contact enrich request resource."},"ContactEnrichRequest":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/ContactEnrichRequestResource"}],"description":"The primary data of the document"}},"description":"Contact enrich request."},"CompanyStatus":{"type":"string","enum":["NEW","ALIVE","DEFUNCT_DOMAIN_DOWN","DEFUNCT_DECLARATION","DEFUNCT_MANUAL","DEFUNCT_FORMER_NAME","DEFUNCT_ACQUISITION"],"description":"Represents the current status of the company"},"Competitor":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Unique ZoomInfo identifier for the competitor."},"name":{"type":"string","description":"Name of the competitor."},"rank":{"type":"integer","format":"int32","description":"Ranking of the competitor."},"website":{"type":"string","description":"Website of the competitor."},"employeeCount":{"type":"integer","format":"int32","description":"EmployeeCount of the competitor."}},"description":"Competitor details."},"Address":{"type":"object","properties":{"street":{"type":"string","description":"Street portion of the company's location."},"city":{"type":"string","description":"City of the company's primary address."},"state":{"type":"string","description":"State or province of the company's address."},"country":{"type":"string","description":"Country of the company's primary address."},"zipCode":{"type":"string","description":"Zip code or postal code of the company's address."}},"description":"Address details for the company's location."},"LocationMatch":{"type":"object","properties":{"companyId":{"type":"integer","format":"int64","description":"Unique ZoomInfo identifier for the company."},"address":{"allOf":[{"$ref":"#/components/schemas/Address"}],"description":"Address details for the company's location."},"addressStatus":{"type":"string","description":"Address status for the location (CURRENT, VALID, PAST)."}},"description":"Location details that match address-related input parameters. Includes companyId, address, and addressStatus (CURRENT, VALID, PAST)."},"CompanyFunding":{"type":"object","properties":{"date":{"type":"string","description":"Date of funding round."},"type":{"type":"string","description":"Type of funding round."},"amount":{"type":"integer","format":"int64","description":"Amount of funding round."},"investors":{"type":"array","items":{"type":"string"},"description":"Investors in funding round."}},"description":"Company funding details."},"DepartmentBudget":{"type":"object","properties":{"marketingBudget":{"type":"integer","format":"int32","description":"Marketing budget."},"financialBudget":{"type":"integer","format":"int32","description":"Finance budget."},"itBudget":{"type":"integer","format":"int32","description":"IT budget."},"hrBudget":{"type":"integer","format":"int32","description":"HR budget."}},"description":"Department budget details."},"EmployeeCountByDepartment":{"type":"object","properties":{"cSuite":{"type":"integer","format":"int32","description":"CSuite."},"finance":{"type":"integer","format":"int32","description":"Finance."},"humanResources":{"type":"integer","format":"int32","description":"HumanResources."},"sales":{"type":"integer","format":"int32","description":"Sales."},"operations":{"type":"integer","format":"int32","description":"Operations."},"informationTechnology":{"type":"integer","format":"int32","description":"InformationTechnology."},"engineeringAndTechnical":{"type":"integer","format":"int32","description":"EngineeringAndTechnical."},"marketing":{"type":"integer","format":"int32","description":"Marketing."},"legal":{"type":"integer","format":"int32","description":"Legal."},"medicalAndHealth":{"type":"integer","format":"int32","description":"MedicalAndHealth."}},"description":"Employee count by department."},"CompanyEnrichResponseAttributes":{"type":"object","properties":{"socialMediaUrls":{"type":"array","items":{"$ref":"#/components/schemas/SocialMediaUrl"},"description":"Social media URLs for the company (e.g., Facebook, Twitter, LinkedIn and so on)."},"primaryIndustry":{"type":"array","items":{"type":"string"},"description":"Top-level industry for a company."},"primaryIndustryCode":{"type":"array","items":{"$ref":"#/components/schemas/PrimaryIndustryCode"},"description":"Top-level industry for a company along with its code."},"primarySubIndustryCode":{"type":"array","items":{"$ref":"#/components/schemas/PrimarySubIndustryCode"},"description":"Top-level sub-industry for a company along with its code."},"industries":{"type":"array","items":{"type":"string"},"description":"The industry grouping for the company. A company can have multiple industries."},"industryCodes":{"type":"array","items":{"$ref":"#/components/schemas/IndustryCode"},"description":"The industry grouping for the company along with it's codes. A company can have multiple industries."},"website":{"type":"string","description":"Company website."},"type":{"type":"string","description":"Company type (private, public, npo, education, government, other)."},"ticker":{"type":"string","description":"Company public stock exchange ticker."},"name":{"type":"string","description":"Company name."},"description":{"type":"string","description":"Description associated with the company."},"phone":{"type":"string","description":"Company phone number."},"fax":{"type":"string","description":"Fax number of the company headquarters."},"street":{"type":"string","description":"Street portion of the company's primary address."},"city":{"type":"string","description":"City of the company's primary address."},"state":{"type":"string","description":"State or province of the company's primary address."},"zipCode":{"type":"string","description":"Zip code or postal code of the company's primary address."},"country":{"type":"string","description":"Country of the company's primary address."},"continent":{"type":"string","description":"Continent of the company's primary address."},"logo":{"type":"string","description":"The URL which can be used to retrieve the logo for the company."},"alternateLogos":{"type":"array","items":{"type":"string"},"description":"List of alternate logos for the company."},"employeeCount":{"type":"integer","format":"int32","description":"Employee count of the company."},"sicCodes":{"type":"array","items":{"$ref":"#/components/schemas/SicCode"},"description":"The Standard Industrial Classification is a system for classifying industries by a four-digit numerical code assigned by the U.S. government to business establishments to identify the primary business of the establishment."},"naicsCodes":{"type":"array","items":{"$ref":"#/components/schemas/NaicsCode"},"description":"Four-digit numerical codes assigned by the U.S. government to business establishments to identify the primary business of the establishment."},"employeeRange":{"type":"string","description":"Employee range at the company."},"employeeGrowth":{"allOf":[{"$ref":"#/components/schemas/EmployeeGrowth"}],"description":"Employee growth rate at the company."},"revenueRange":{"type":"string","description":"Revenue range for a company."},"domainList":{"type":"array","items":{"type":"string"},"description":"List of domains associated with a company."},"revenue":{"type":"integer","format":"int64","description":"Approximate yearly revenue for the company in 1000's. For example, a $100M company is expressed as 100000."},"numberOfContactsInZoomInfo":{"type":"integer","format":"int32","description":"Number of ZoomInfo contacts associated with company."},"companyStatus":{"allOf":[{"$ref":"#/components/schemas/CompanyStatus"}],"description":"Company status."},"companyStatusDate":{"type":"string","format":"date-time","description":"Date of last company status update."},"competitors":{"type":"array","items":{"$ref":"#/components/schemas/Competitor"},"description":"List of competitors."},"ultimateParentId":{"type":"integer","format":"int64","description":"Unique ZoomInfo identifier for ultimate parent company (if exists)."},"ultimateParentName":{"type":"string","description":"Company name for ultimate parent company (if exists)."},"ultimateParentRevenue":{"type":"integer","format":"int32","description":"Approximate yearly revenue for the ultimate parent company."},"ultimateParentEmployees":{"type":"integer","format":"int32","description":"Approximate number of people employed by the ultimate parent company."},"subUnitType":{"type":"string","description":"Company sub unit types (e.g., division, subsidiary, etc.)."},"subUnitIndustries":{"type":"array","items":{"type":"string"},"description":"Company sub unit industries."},"parentId":{"type":"integer","format":"int64","description":"Unique ZoomInfo identifier associated with the parent company."},"parentName":{"type":"string","description":"Company name associated with the parent company."},"locationCount":{"type":"integer","format":"int32","description":"Number of office locations associated with a company."},"locationMatch":{"allOf":[{"$ref":"#/components/schemas/LocationMatch"}],"description":"Location details that match address-related input parameters. Includes companyId, address, and addressStatus (CURRENT, VALID, PAST)."},"metroArea":{"type":"string","description":"Company metro area."},"lastUpdatedDate":{"type":"string","format":"date-time","description":"Date on which the company record was last updated."},"createdDate":{"type":"string","format":"date-time","description":"Date on which the company record was created."},"certificationDate":{"type":"string","format":"date-time","description":"Date of certification."},"certified":{"type":"boolean","description":"Denotes if ZoomInfo's research and data team has confirmed activity within the past 12 months."},"products":{"type":"array","items":{"type":"string"},"description":"List of products associated with a company."},"companyFunding":{"type":"array","items":{"$ref":"#/components/schemas/CompanyFunding"},"description":"List of funding rounds including date, type , investors, and amount."},"recentFundingAmount":{"type":"integer","format":"int32","description":"Most recent funding amount."},"recentFundingDate":{"type":"string","format":"date-time","description":"Date of most recent funding."},"totalFundingAmount":{"type":"integer","format":"int32","description":"Total funding to date."},"foundedYear":{"type":"string","description":"Year the company was founded."},"businessModel":{"type":"array","items":{"type":"string"},"description":"Business model for a company."},"isDefunct":{"type":"boolean","description":"Indicates whether the company still exists."},"departmentBudgets":{"allOf":[{"$ref":"#/components/schemas/DepartmentBudget"}],"description":"Estimated department budgets. Returns estimated budget values including marketingBudget, financeBudget, itBudget and hrBudget."},"employeeCountByDepartment":{"allOf":[{"$ref":"#/components/schemas/EmployeeCountByDepartment"}],"description":"Employee count by company department."},"engagements":{"type":"array","items":{"$ref":"#/components/schemas/Engagement"},"description":"List of the company's engagements. Includes the date and type of each engagement."}},"description":"Company enrich response attributes.","x-class-extra-annotation":"@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true)"},"CompanyMatchStatus":{"type":"string","enum":["FULL_MATCH","NO_MATCH","LIMIT_EXCEEDED","INVALID_INPUT"],"x-enumDescriptions":{"FULL_MATCH":"Match status indicating a full match with all criteria met.","NO_MATCH":"Match status indicating no match found.","LIMIT_EXCEEDED":"Match status indicating the enrich request credit limit has been exceeded.","INPUT_ERROR":"Match status indicating an error with the input data."}},"CompanyEnrichRequestCriteria":{"type":"object","properties":{"companyId":{"type":"integer","format":"int64","description":"Unique ZoomInfo identifier for a company."},"companyName":{"type":"string","description":"Company name."},"companyWebsite":{"type":"string","description":"Company website URL in http://www.example.com format. Accepts a comma-separated list."},"companyTicker":{"type":"string","description":"Company stock ticker symbol."},"companyPhone":{"type":"string","description":"Phone number of the company headquarters."},"companyFax":{"type":"string","description":"Fax number of the company headquarters."},"companyStreet":{"type":"string","description":"Street portion of the company's primary address."},"companyCity":{"type":"string","description":"City portion of the company's primary address."},"companyState":{"type":"string","description":"Company state (U.S.) or province (Canada). You can use free text state or province names (e.g., 'new hampshire'), or the two-letter common abbreviation for a U.S. state (e.g., 'nh')."},"companyZipCode":{"type":"string","description":"Zip code or postal code of the company's primary address."},"companyCountry":{"type":"string","description":"Country of the company's primary address. You can use free text or see the Country lookup endpoint for values."},"ipAddress":{"type":"string","description":"IP address associated with the company."}},"description":"Company enrich request criteria."},"CompanyAttributeMeta":{"type":"object","required":["matchStatus","input"],"properties":{"matchStatus":{"allOf":[{"$ref":"#/components/schemas/CompanyMatchStatus"}],"description":"The match status for the company enrich operation, indicating whether a match was found and the type of match."},"input":{"allOf":[{"$ref":"#/components/schemas/CompanyEnrichRequestCriteria"}],"description":"The input criteria that was used to perform the company enrich match. This provides traceability for the match result."},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/Warning"},"description":"Details about any warnings encountered during the validation of the enrich request input criteria."}},"description":"Metadata describing the result of a company enrich match, including the match status and the input criteria used for the match. Used to provide additional context about how the company enrich response was determined."},"EnrichCompany":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"Company","pattern":"Company"},"attributes":{"allOf":[{"$ref":"#/components/schemas/CompanyEnrichResponseAttributes"}],"description":"The attributes defining the resource"},"meta":{"allOf":[{"$ref":"#/components/schemas/CompanyAttributeMeta"}],"description":"Non-standard meta information about the resource"}},"description":"A matching company was identified from the provided input data. This result will always be a FULL_MATCH (where the company information matched). The match status can be found within the meta object for reference."},"NoMatchCompany":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"The unique identifier of the resource"},"type":{"type":"string","description":"The type identifier of the resource","default":"NoMatch","pattern":"NoMatch"},"meta":{"allOf":[{"$ref":"#/components/schemas/CompanyAttributeMeta"}],"description":"Non-standard meta information about the resource"}},"description":"There was not a matching company found for the provided input or is been filtered out because of match statue - LIMIT_EXCEEDED (User credit limit has been exceeded). Exact details can be found within the meta object including the match status and other accompanying metadata."},"CompanyEnrichResponseResourceUnion":{"type":"object","oneOf":[{"$ref":"#/components/schemas/EnrichCompany"},{"$ref":"#/components/schemas/NoMatchCompany"}],"discriminator":{"propertyName":"type","mapping":{"Company":"#/components/schemas/EnrichCompany","NoMatch":"#/components/schemas/NoMatchCompany"}},"description":"Represents the possible resource types returned in a company enrich response, including both a successful company match and a no-match result. Used to encapsulate the response resource for company enrichment."},"CompanyEnrichResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CompanyEnrichResponseResourceUnion"},"description":"The primary data of the document"}},"description":"Company enrich response."},"CompanyEnrichRequestAttributes":{"type":"object","required":["outputFields","matchCompanyInput"],"properties":{"outputFields":{"type":"array","items":{"type":"string","enum":["alternateLogos","businessModel","certificationDate","certified","city","companyFunding","companyStatus","companyStatusDate","competitors","continent","country","createdDate","departmentBudgets","description","domainList","employeeCount","employeeCountByDepartment","employeeGrowth","employeeRange","engagements","fax","foundedYear","id","industries","industryCodes","isDefunct","lastUpdatedDate","locationCount","locationMatch","logo","metroArea","naicsCodes","name","numberOfContactsInZoomInfo","parentId","parentName","phone","primaryIndustry","primaryIndustryCode","primarySubIndustryCode","products","recentFundingAmount","recentFundingDate","revenue","revenueRange","sicCodes","socialMediaUrls","state","street","subUnitIndustries","subUnitType","ticker","totalFundingAmount","type","ultimateParentEmployees","ultimateParentId","ultimateParentName","ultimateParentRevenue","website","zipCode"]},"description":"List of fields to be returned in the response."},"matchCompanyInput":{"type":"array","items":{"$ref":"#/components/schemas/CompanyEnrichRequestCriteria"},"minItems":1,"maxItems":25,"description":"List of criteria to match against."}},"description":"Company enrich request attributes."},"CompanyEnrichRequestResource":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"The type of the resource","default":"CompanyEnrich","pattern":"CompanyEnrich"},"attributes":{"allOf":[{"$ref":"#/components/schemas/CompanyEnrichRequestAttributes"}],"description":"The attributes defining the resource"}},"description":"Company enrich request resource."},"CompanyEnrichRequest":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/CompanyEnrichRequestResource"}],"description":"The primary data of the document"}},"description":"Company enrich request."},"Parentage":{"type":"object","properties":{"city":{"type":"string","description":"City of the company's primary address."},"state":{"type":"string","description":"State or province of the company's primary address."},"companyId":{"type":"string","description":"Unique ZoomInfo identifier for a company."},"companyName":{"type":"string","description":"Company name."},"subUnitType":{"type":"string","description":"Company sub types (e.g., division, subsidiary). Use this in conjunction with parentId or ultimateParentId."},"subUnitDesc":{"type":"string","description":"Contains a description of the sub unit listed in the corporate hierarchy."},"acquiredByDate":{"type":"string","description":"Denotes the date when the parent company acquired the input company if available."}},"description":"Lists companies higher up in the corporate hierarchy for this company."},"SubUnitTypeInfo":{"type":"object","required":["typeDescription"],"properties":{"typeId":{"type":"integer","description":"ID of the sub unit type."},"typeDescription":{"type":"string","description":"Description of the sub unit type."}},"description":"Denotes the type of sub-unit represented by a family node within the corporate hierarchy."},"FamilyNode":{"type":"object","required":["subUnitTypeInfo"],"properties":{"city":{"type":"string","description":"City of the company's primary address."},"state":{"type":"string","description":"State or province of the company's primary address."},"name":{"type":"string","description":"Company name."},"companyId":{"type":"integer","format":"int64","description":"Unique ZoomInfo identifier for a company."},"subUnitTypeInfo":{"allOf":[{"$ref":"#/components/schemas/SubUnitTypeInfo"}],"description":"Denotes the type of sub-unit represented by a family node within the corporate hierarchy."},"familyNodes":{"description":"Denotes a branch or sub-branch of the family tree within the corporate hierarchy.","type":"array","items":{"$ref":"#/components/schemas/FamilyNode"}}},"description":"Family node information."},"FamilyTree":{"type":"object","properties":{"city":{"type":"string","description":"City of the company's primary address."},"state":{"type":"string","description":"State or province of the company's primary address."},"companyId":{"type":"integer","format":"int64","description":"Unique ZoomInfo identifier for a company."},"name":{"type":"string","description":"Company name."},"familyNodes":{"type":"array","items":{"$ref":"#/components/schemas/FamilyNode"},"description":"Denotes a branch or sub-branch of the family tree within the corporate hierarchy."}},"description":"Family tree information."},"CorporateHierarchyEnrichResponseAttributes":{"type":"object","properties":{"companyId":{"type":"integer","format":"int64","description":"Unique ZoomInfo identifier for a company."},"parentage":{"type":"array","items":{"$ref":"#/components/schemas/Parentage"},"description":"Lists companies higher up in the corporate hierarchy for this company."},"familyTree":{"type":"array","items":{"$ref":"#/components/schemas/FamilyTree"},"description":"Lists companies and locations in the family tree for this company."}},"description":"Corporate hierarchy enrich response attributes."},"CorporateHierarchyEnrichRequestCriteria":{"type":"object","properties":{"companyId":{"type":"integer","format":"int64","description":"Unique ZoomInfo identifier for a company."},"companyName":{"type":"string","description":"Company name."},"companyWebsite":{"type":"string","description":"Company website URL in http://www.example.com format."}},"description":"Corporate hierarchy enrich request criteria."},"CorporateHierarchyAttributeMeta":{"type":"object","required":["matchStatus","input"],"properties":{"matchStatus":{"allOf":[{"$ref":"#/components/schemas/CompanyMatchStatus"}],"description":"The match status for the corporate hierarchy enrich operation, indicating whether a match was found and the type of match."},"input":{"allOf":[{"$ref":"#/components/schemas/CorporateHierarchyEnrichRequestCriteria"}],"description":"The input criteria that was used to perform the corporate hierarchy enrich match. This provides traceability for the match result."},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/Warning"},"description":"Details about any warnings encountered during the validation of the enrich request input criteria."}},"description":"Metadata describing the result of a corporate hierarchy enrich match, including the match status and the input criteria used for the match. Used to provide additional context about how the corporate hierarchy enrich response was determined."},"EnrichCorporateHierarchy":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"CorporateHierarchy","pattern":"CorporateHierarchy"},"attributes":{"allOf":[{"$ref":"#/components/schemas/CorporateHierarchyEnrichResponseAttributes"}],"description":"The attributes defining the resource"},"meta":{"allOf":[{"$ref":"#/components/schemas/CorporateHierarchyAttributeMeta"}],"description":"Non-standard meta information about the resource"}},"description":"A matching corporate hierarchy was identified from the provided input data. This result will always be a FULL_MATCH (where the company information matched). The match status can be found within the meta object for reference."},"NoMatchCorporateHierarchy":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"The unique identifier of the resource"},"type":{"type":"string","description":"The type identifier of the resource","default":"NoMatch","pattern":"NoMatch"},"meta":{"allOf":[{"$ref":"#/components/schemas/CorporateHierarchyAttributeMeta"}],"description":"Non-standard meta information about the resource"}},"description":"There was not a matching corporate hierarchy found for the provided input or is been filtered out because of match statue - LIMIT_EXCEEDED (User credit limit has been exceeded). Exact details can be found within the meta object including the match status and other accompanying metadata."},"CorporateHierarchyEnrichResponseResourceUnion":{"type":"object","oneOf":[{"$ref":"#/components/schemas/EnrichCorporateHierarchy"},{"$ref":"#/components/schemas/NoMatchCorporateHierarchy"}],"discriminator":{"propertyName":"type","mapping":{"CorporateHierarchy":"#/components/schemas/EnrichCorporateHierarchy","NoMatch":"#/components/schemas/NoMatchCorporateHierarchy"}},"description":"Represents the possible resource types returned in a corporate hierarchy enrich response, including both a successful corporate hierarchy match and a no-match result. Used to encapsulate the response resource for corporate hierarchy enrichment."},"CorporateHierarchyEnrichResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CorporateHierarchyEnrichResponseResourceUnion"},"description":"The primary data of the document"}},"description":"Corporate hierarchy enrich response."},"CorporateHierarchyEnrichRequestAttributes":{"type":"object","required":["outputFields","matchCompanyInput"],"properties":{"outputFields":{"type":"array","items":{"type":"string"},"description":"List of fields to be returned in the response."},"matchCompanyInput":{"type":"array","items":{"$ref":"#/components/schemas/CorporateHierarchyEnrichRequestCriteria"},"minItems":1,"maxItems":25,"description":"List of criteria to match against."}},"description":"Corporate hierarchy enrich request attributes."},"CorporateHierarchyEnrichRequestResource":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"The type of the resource","default":"CorporateHierarchyEnrich","pattern":"CorporateHierarchyEnrich"},"attributes":{"allOf":[{"$ref":"#/components/schemas/CorporateHierarchyEnrichRequestAttributes"}],"description":"The attributes defining the resource"}},"description":"Corporate hierarchy enrich request resource."},"CorporateHierarchyEnrichRequest":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/CorporateHierarchyEnrichRequestResource"}],"description":"The primary data of the document"}},"description":"Corporate hierarchy enrich request."},"TopSignalLocation":{"type":"object","properties":{"city":{"type":"string","description":"City for the intent's signal location."},"country":{"type":"string","description":"Country for the intent's signal location."},"state":{"type":"string","description":"State for the intent's signal location."}},"description":"Intent enrich request attributes."},"IntentEnrichResponseAttributes":{"type":"object","properties":{"category":{"type":"string","description":"Intent category."},"topic":{"type":"string","description":"Intent topic."},"signalScore":{"type":"integer","format":"int32","description":"Signal score for the topic."},"audienceStrength":{"type":"string","description":"Audience strength for the topic."},"signalDate":{"type":"string","format":"date-time","description":"Date the signal was identified."},"company":{"allOf":[{"$ref":"#/components/schemas/IntentCompany"}],"description":"Company data for the intent topic."},"recommendedContacts":{"type":"array","items":{"$ref":"#/components/schemas/RecommendedContact"},"description":"Suggested contacts at the company that are related to the intent topic."},"spikesInDateRange":{"type":"integer","format":"int32","description":"The total number of intent signals detected during your specified timeframe."},"topSignalLocations":{"type":"array","items":{"$ref":"#/components/schemas/TopSignalLocation"},"description":"Up to top 3 signal locations identified for the Intent"}},"description":"Attributes of a single intent result.","x-class-extra-annotation":"@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true)"},"IntentEnrichResponseResource":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"Intent","pattern":"Intent"},"attributes":{"allOf":[{"$ref":"#/components/schemas/IntentEnrichResponseAttributes"}],"description":"The attributes defining the resource"}},"description":"Intent"},"IntentEnrichResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/IntentEnrichResponseResource"},"description":"The primary data of the document"},"meta":{"allOf":[{"$ref":"#/components/schemas/ResultMeta"}],"description":"Non-standard meta information about the document"},"links":{"allOf":[{"$ref":"#/components/schemas/Links"}],"description":"Links related to the primary data"}},"description":"A list of Intent topics that match the criteria specified in the request"},"IntentEnrichRequestAttributes":{"type":"object","required":["topics"],"properties":{"companyId":{"type":"integer","format":"int64","description":"Unique ZoomInfo identifier for a company."},"companyName":{"type":"string","description":"Company name."},"topics":{"type":"array","items":{"type":"string"},"description":"Intent topics. Accepts an Array of up to 50 Strings. See the 'Intent Topics' Lookup endpoint for values."},"signalStartDate":{"type":"string","format":"date","description":"Start date for a company signaling interest in a topic. Uses YYYY-MM-DD format."},"signalEndDate":{"type":"string","format":"date","description":"End date for a company signaling interest in a topic. Uses YYYY-MM-DD format."},"signalScoreMin":{"type":"integer","format":"int32","description":"Minimum signal score. Use with signalScoreMax to form a range. Minimum score is 60 and maximum is 100."},"signalScoreMax":{"type":"integer","format":"int32","description":"Maximum signal score. Use with signalScoreMin to form a range. Minimum score is 60 and maximum is 100."},"audienceStrengthMin":{"type":"string","description":"Minimum audience strength score. Use with audienceStrengthMax to form a range. Values are A, B, C, D, and E, with A indicating a larger audience."},"audienceStrengthMax":{"type":"string","description":"Maximum audience strength score. Use with audienceStrengthMin to form a range. Values are A, B, C, D, and E, with A indicating a larger audience."},"findRecommendedContacts":{"type":"boolean","description":"Default is true. Set to false to exclude recommended contacts from results."},"companyWebsite":{"type":"string","description":"Company website URL in http://www.example.com format. Accepts a comma-separated list."}},"description":"Intent enrich request attributes."},"IntentEnrichRequestResource":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"The type of the resource","default":"IntentEnrich","pattern":"IntentEnrich"},"attributes":{"allOf":[{"$ref":"#/components/schemas/IntentEnrichRequestAttributes"}],"description":"The attributes defining the resource"}},"description":"Intent enrich request resource."},"IntentEnrichRequest":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/IntentEnrichRequestResource"}],"description":"The primary data of the document"}},"description":"Intent enrich request."},"NewsEnrichResponseResource":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"News","pattern":"News"},"attributes":{"allOf":[{"$ref":"#/components/schemas/NewsResponseAttributes"}],"description":"The attributes defining the resource"}},"description":"News"},"NewsEnrichResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NewsEnrichResponseResource"},"description":"The primary data of the document"},"meta":{"allOf":[{"$ref":"#/components/schemas/ResultMeta"}],"description":"Non-standard meta information about the document"},"links":{"allOf":[{"$ref":"#/components/schemas/Links"}],"description":"Links related to the primary data"}},"description":"A list of News that match the criteria specified in the request"},"NewsEnrichRequestAttributes":{"type":"object","properties":{"companyId":{"type":"integer","format":"int64","description":"Unique ZoomInfo identifier for the company."},"categories":{"type":"array","items":{"type":"string"},"description":"Category of news articles. Accepts an Array of String. See the 'News Categories' lookup endpoint for values."},"url":{"type":"array","items":{"type":"string"},"description":"News URL strings. Accepts an Array of String. Minimum of 5 characters per input"},"pageDateMin":{"type":"string","format":"date","description":"Specify the earliest publishing date for news articles returned. Uses YYYY-MM-DD format (e.g., 2020-01-01 will return all news articles published on or after Jan 1, 2020)."},"pageDateMax":{"type":"string","format":"date","description":"Specify the latest publishing date for news articles articles. Uses YYYY-MM-DD format (e.g., 2020-01-31 will return all new articles published on or before Jan 31, 2020)."}},"description":"Request attributes for news enrich."},"NewsEnrichResource":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"The type of the resource","default":"NewsEnrich","pattern":"NewsEnrich"},"attributes":{"allOf":[{"$ref":"#/components/schemas/NewsEnrichRequestAttributes"}],"description":"The attributes defining the resource"}},"description":"News enrich request resource."},"NewsEnrichRequest":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/NewsEnrichResource"}],"description":"The primary data of the document"}},"description":"News enrich request."},"OrgChartEnrichResponseAttributes":{"type":"object","properties":{"firstName":{"type":"string","description":"Contact first name."},"middleName":{"type":"string","description":"Contact middle name"},"lastName":{"type":"string","description":"Contact last name."},"lastUpdatedDate":{"type":"string","description":"Date on which the contact record was last updated."},"title":{"type":"string","description":"Contact job title at current place of employment."},"hasEmail":{"type":"boolean","description":"Indicates whether ZoomInfo has an email address for the contact."},"hasDirectPhone":{"type":"boolean","description":"Indicates whether ZoomInfo has a direct phone number for the contact."},"department":{"type":"string","description":"Contact department at current place of employment."},"jobFunction":{"type":"string","description":"Contact job function at current place of employment."},"orgChartTier":{"type":"integer","format":"int32","description":"Integer representing hierarchy within a department, with 1 being the highest."},"orgChartSubTier":{"type":"integer","format":"int32","description":"Secondary tier within orgChartTier."},"contactAccuracyScore":{"type":"number","format":"double","description":"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."},"companyId":{"type":"string","description":"Unique ZoomInfo identifier for a company."},"companyName":{"type":"string","description":"Company name."}},"description":"Org chart enrich response attributes.","x-class-extra-annotation":"@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true)"},"OrgChartEnrichResponseResource":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"OrgChart","pattern":"OrgChart"},"attributes":{"allOf":[{"$ref":"#/components/schemas/OrgChartEnrichResponseAttributes"}],"description":"The attributes defining the resource"}},"description":"Org chart."},"OrgChartEnrichResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OrgChartEnrichResponseResource"},"description":"The primary data of the document"},"meta":{"allOf":[{"$ref":"#/components/schemas/ResultMeta"}],"description":"Non-standard meta information about the document"},"links":{"allOf":[{"$ref":"#/components/schemas/Links"}],"description":"Links related to the primary data"}},"description":"Org charts that match the criteria specified in the request"},"OrgChartEnrichRequestAttributes":{"type":"object","properties":{"companyId":{"type":"string","description":"The ID of the company for which you want to view the org chart."},"department":{"type":"string","description":"A comma-separated string of departments to display org charts for."},"contactAccuracyScoreMin":{"type":"string","description":"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."},"contactAccuracyScoreMax":{"type":"string","description":"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."}},"description":"Org chart enrich request attributes."},"OrgChartEnrichRequestResource":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"The type of the resource","default":"OrgChartEnrich","pattern":"OrgChartEnrich"},"attributes":{"allOf":[{"$ref":"#/components/schemas/OrgChartEnrichRequestAttributes"}],"description":"The attributes defining the resource"}},"description":"Org chart enrich request resource."},"OrgChartEnrichRequest":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/OrgChartEnrichRequestResource"}],"description":"The primary data of the document"}},"description":"Org chart enrich request."},"ScoopEnrichResponseAttributes":{"type":"object","properties":{"id":{"type":"string","description":"ZoomInfo unique identifier for a scoop."},"publishedDate":{"type":"string","format":"date-time","description":"Date when a scoop was published."},"originalPublishedDate":{"type":"string","format":"date-time","description":"Date when a scoop was originally published."},"linkText":{"type":"string","description":"Link text for a scoop."},"link":{"type":"string","description":"URL for a scoop."},"description":{"type":"string","description":"Description associated with the scoop"},"topics":{"type":"array","items":{"type":"object","additionalProperties":{}},"description":"Scoop topics."},"updateText":{"type":"string","description":"Text related to an updated scoop."},"types":{"type":"array","items":{"type":"object","additionalProperties":{}},"description":"Types associated with a scoop."},"company":{"allOf":[{"$ref":"#/components/schemas/ScoopCompany"}],"description":"Company"},"contacts":{"type":"array","items":{"$ref":"#/components/schemas/ScoopContact"},"description":"Contacts associated with a scoop."}},"description":"Scoop enrich response attributes."},"ScoopEnrichResponseResource":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"Scoop","pattern":"Scoop"},"attributes":{"allOf":[{"$ref":"#/components/schemas/ScoopEnrichResponseAttributes"}],"description":"The attributes defining the resource"}},"description":"Scoop"},"ScoopEnrichResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ScoopEnrichResponseResource"},"description":"The primary data of the document"},"meta":{"allOf":[{"$ref":"#/components/schemas/ResultMeta"}],"description":"Non-standard meta information about the document"},"links":{"allOf":[{"$ref":"#/components/schemas/Links"}],"description":"Links related to the primary data"}},"description":"A list of scoop that match the criteria specified in the request"},"ScoopEnrichRequestAttributes":{"type":"object","properties":{"publishedStartDate":{"type":"string","format":"date","description":"Starting date to search for scoops based on publication date. Form a range using publishedEndDate or omit publishedEndDate to search to the current date. Uses YYYY-MM-DD format."},"publishedEndDate":{"type":"string","format":"date","description":"Ending date to search for scoops based on publication date. Form a range using publishedStartDate. Uses YYYY-MM-DD format."},"updatedSinceCreation":{"type":"boolean","description":"Default is false. Setting true will only return scoops that have been updated since publishedStartDate."},"scoopType":{"type":"string","description":"Retrieve scoops based on type (e.g. earnings, awards and partnerships). Accepts a comma-separated list of IDs from the lookup endpoint."},"scoopTopic":{"type":"string","description":"Retrieve scoops based on topic (e.g. integration, consolidation and compliance). Accepts a comma-separated list of IDs from the lookup endpoint."},"department":{"type":"string","description":"Retrieve scoops based on department (IT, finance, HR and so on). See the Scoop Departments lookup endpoint for valid inputs.."},"scoopId":{"type":"string","description":"ZoomInfo unique identifier for a Scoop. Accepts a comma-separated list."},"description":{"type":"string","description":"Search for scoops based on description.  Accepts a space-separated list of individual words."},"companyId":{"type":"string","description":"ZoomInfo unique identifier for the company. Will accept a comma-separated list."},"companyName":{"type":"string","description":"Company name."},"companyWebsite":{"type":"string","description":"Company website URL in http://www.example.com format. Accepts a comma-separated list."}},"description":"Scoop enrich request attributes."},"ScoopEnrichRequestResource":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"The type of the resource","default":"ScoopEnrich","pattern":"ScoopEnrich"},"attributes":{"allOf":[{"$ref":"#/components/schemas/ScoopEnrichRequestAttributes"}],"description":"The attributes defining the resource"}},"description":"Scoop enrich request resource."},"ScoopEnrichRequest":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/ScoopEnrichRequestResource"}],"description":"The primary data of the document"}},"description":"Scoop enrich request."},"TechnologyEnrichResponseAttributes":{"type":"object","properties":{"categoryParent":{"type":"string","description":"Parent Category for the retrieved data."},"category":{"type":"string","description":"Category for the retrieved data."},"vendor":{"type":"string","description":"Vendor associated with the data being returned."},"product":{"type":"string","description":"Product associated with the data being returned."},"attribute":{"type":"string","description":"Attribute of the technology."},"website":{"type":"string","description":"Website associated with the data being returned."},"logo":{"type":"string","description":"The URL which can be used to retrieve the logo."},"domain":{"type":"string","description":"Domain associated with the data being returned."},"createdDate":{"type":"string","format":"date","description":"Date when the data was created. Uses YYYY-MM-DD format."},"modifiedDate":{"type":"string","format":"date","description":"Date when the data was last modified. Uses YYYY-MM-DD format."},"description":{"type":"string","description":"Description of the data being returned."}},"description":"Technology enrich response attributes.","x-class-extra-annotation":"@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true)"},"TechnologyEnrichResponseResource":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"Technology","pattern":"Technology"},"attributes":{"allOf":[{"$ref":"#/components/schemas/TechnologyEnrichResponseAttributes"}],"description":"The attributes defining the resource"}},"description":"Technology enrich response resource."},"NonPaginatedResultMeta":{"type":"object","required":["totalResults"],"properties":{"totalResults":{"type":"integer","format":"uint32","description":"The total number of results based on the specified filters"}},"description":"Metadata for non-paginated results, including the total number of results"},"TechnologyEnrichResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TechnologyEnrichResponseResource"},"description":"The primary data of the document"},"meta":{"allOf":[{"$ref":"#/components/schemas/NonPaginatedResultMeta"}],"description":"Non-standard meta information about the document"}},"description":"Technology enrich response."},"TechnologyEnrichRequestAttributes":{"type":"object","properties":{"companyId":{"type":"integer","format":"int64","description":"Unique ZoomInfo Identifier for the company."}},"description":"Request attributes for technology enrich."},"TechnologyEnrichRequestResource":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"The type of the resource","default":"TechnologyEnrich","pattern":"TechnologyEnrich"},"attributes":{"allOf":[{"$ref":"#/components/schemas/TechnologyEnrichRequestAttributes"}],"description":"The attributes defining the resource"}},"description":"Technology enrich request resource."},"TechnologyEnrichRequest":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/TechnologyEnrichRequestResource"}],"description":"The primary data of the document"}},"description":"Technology enrich request."},"HashtagEnrichResponseAttributes":{"type":"object","properties":{"searchString":{"type":"string","description":"Search string for a hashtag."},"displayLabel":{"type":"string","description":"Display label for a hashtag."},"description":{"type":"string","description":"Description of the data being returned."},"group":{"type":"string","description":"Group associated with the hashtag."},"priority":{"type":"integer","format":"int32","description":"Priority of the hashtag."},"parentCategory":{"type":"string","description":"Parent Category for the retrieved data."},"displayScore":{"type":"string","description":"Display score for the hashtag."},"hidden":{"type":"boolean","description":"Indicates whether the hashtag is hidden."},"categorizedFlag":{"type":"boolean","description":"Indicates whether the hashtag is categorized."},"label":{"type":"string","description":"Label for the hashtag."}},"description":"Hashtag enrich response Attributes.","x-class-extra-annotation":"@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true)"},"HashtagEnrichResponseResource":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"Hashtag","pattern":"Hashtag"},"attributes":{"allOf":[{"$ref":"#/components/schemas/HashtagEnrichResponseAttributes"}],"description":"The attributes defining the resource"}},"description":"Hashtag enrich response resource."},"HashtagEnrichResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/HashtagEnrichResponseResource"},"description":"The primary data of the document"},"meta":{"allOf":[{"$ref":"#/components/schemas/NonPaginatedResultMeta"}],"description":"Non-standard meta information about the document"}},"description":"Hashtag enrich response."},"HashtagEnrichRequestAttributes":{"type":"object","properties":{"companyId":{"type":"integer","format":"int64","description":"Unique ZoomInfo Identifier for the company."}},"description":"Request attributes for hashtag enrich."},"HashtagEnrichRequestResource":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"The type of the resource","default":"HashtagEnrich","pattern":"HashtagEnrich"},"attributes":{"allOf":[{"$ref":"#/components/schemas/HashtagEnrichRequestAttributes"}],"description":"The attributes defining the resource"}},"description":"Hashtag enrich request resource."},"HashtagEnrichRequest":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/HashtagEnrichRequestResource"}],"description":"The primary data of the document"}},"description":"Hashtag enrich request."},"FieldNameEnum":{"type":"string","enum":["board-members","buying-groups","company-rankings","company-types","continents","countries","departments","employee-count","hashtags","industries","intent-topics","job-functions","job-titles","management-levels","metro-regions","naics-codes","news-categories","revenue-ranges","scoop-departments","scoop-topics","scoop-types","sic-codes","states","sub-unit-types","tech-categories","tech-products","tech-skills","tech-vendors","years-of-experience"],"description":"All possible lookup field names","x-enumDescriptions":{"boardMembers":"Retrieve accepted Board Member values.","buyingGroups":"Retrieve buying group information.","companyRankings":"Retrieve accepted Company Ranking values.","companyTypes":"Retrieve accepted Company Type values.","continents":"Retrieve accepted Continent values.","countries":"Retrieve accepted Country values.","departments":"Retrieve accepted Contact Department values.","employeeCount":"Retrieve accepted Employee Count values.","hashtags":"Retrieve accepted Hashtag values.","industries":"Retrieve accepted Industry Code values.","intentTopics":"Retrieve accepted intent topics and categories.","jobFunctions":"Retrieve accepted Job Function values.","jobTitles":"Retrieve accepted Job Title values.","managementLevels":"Retrieve accepted Management Level values.","metroRegions":"Retrieve accepted Metro Area values","naicsCodes":"Retrieve accepted North American Industry Classification System (NAICS) values.","newsCategories":"Retrieve accepted news categories.","revenueRanges":"Retrieve accepted Revenue Range values.","scoopDepartments":"Retrieve accepted Scoop Department values.","scoopTopics":"Retrieve accepted Scoop Topic values.","scoopTypes":"Retrieve accepted Scoop Type values.","sicCodes":"Retrieve accepted Standard Industrial Classification (SIC) values.","states":"Retrieve accepted State values.","subUnitTypes":"Retrieve accepted Sub Unit Type values.","techCategories":"Retrieve accepted Tech Category values.","techProducts":"Retrieve accepted Tech Product values.","techSkills":"Retrieve Tech Skill value.","techVendors":"Retrieve accepted Tech Vendor values.","yearsOfExperience":"Retrieve accepted Years Of Experience ranges."}},"BasicEntityModelAttributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the entity"}},"description":"Attributes for a basic entity","x-class-extra-annotation":"@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true)"},"BoardMemberLookup":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"BoardMember","pattern":"BoardMember"},"attributes":{"allOf":[{"$ref":"#/components/schemas/BasicEntityModelAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for board member filters."},"BuyingGroupAccessLevel":{"type":"string","enum":["private","public"],"x-enumDescriptions":{"private":"The access level of the buying group is private","public":"The access level of the buying group is public"}},"PersonaAttributes":{"type":"object","required":["departmentsAndJobFunctions","managementLevels"],"properties":{"departmentsAndJobFunctions":{"type":"array","items":{"type":"string"},"description":"The departments and job functions of the persona"},"managementLevels":{"type":"array","items":{"type":"string"},"description":"The management levels of the persona"},"titles":{"type":"array","items":{"type":"string"},"nullable":true,"description":"The titles of the persona"}},"description":"The attributes of the persona","x-class-extra-annotation":"@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true)"},"BuyingGroupAttributes":{"type":"object","required":["accessLevel","isDefault","name","personas"],"properties":{"accessLevel":{"allOf":[{"$ref":"#/components/schemas/BuyingGroupAccessLevel"}],"description":"The access level of the buying group"},"isDefault":{"type":"boolean","description":"Whether this is the default buying group"},"name":{"type":"string","description":"The name of the buying group"},"personas":{"type":"array","items":{"$ref":"#/components/schemas/PersonaAttributes"},"description":"The details of the personas of the buying group"}},"description":"The attributes for a buying group","x-class-extra-annotation":"@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true)"},"BuyingGroupLookup":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"BuyingGroup","pattern":"BuyingGroup"},"attributes":{"allOf":[{"$ref":"#/components/schemas/BuyingGroupAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the buying groups"},"CompanyRankingLookup":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"CompanyRanking","pattern":"CompanyRanking"},"attributes":{"allOf":[{"$ref":"#/components/schemas/BasicEntityModelAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the company rankings"},"CompanyTypeLookup":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"CompanyType","pattern":"CompanyType"},"attributes":{"allOf":[{"$ref":"#/components/schemas/BasicEntityModelAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the company type"},"ContinentLookup":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"Continent","pattern":"Continent"},"attributes":{"allOf":[{"$ref":"#/components/schemas/BasicEntityModelAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for a continent"},"CountryLookup":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"Country","pattern":"Country"},"attributes":{"allOf":[{"$ref":"#/components/schemas/BasicEntityModelAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for a country"},"DepartmentLookup":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"Department","pattern":"Department"},"attributes":{"allOf":[{"$ref":"#/components/schemas/BasicEntityModelAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the department"},"EmployeeCountLookup":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"EmployeeCount","pattern":"EmployeeCount"},"attributes":{"allOf":[{"$ref":"#/components/schemas/BasicEntityModelAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the employee count"},"HashtagLookup":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"Hashtag","pattern":"Hashtag"},"attributes":{"allOf":[{"$ref":"#/components/schemas/BasicEntityModelAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the hashtag lookup results"},"IndustryLookup":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"Industry","pattern":"Industry"},"attributes":{"allOf":[{"$ref":"#/components/schemas/BasicEntityModelAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the industry"},"TopicEntityModelAttributes":{"type":"object","required":["category","department","description","jobFunction","name"],"properties":{"category":{"type":"string","description":"The category of the topic"},"department":{"type":"string","description":"The department of the topic"},"description":{"type":"string","description":"The description of the topic"},"jobFunction":{"type":"string","description":"The job function of the topic"},"name":{"type":"string","description":"The name of the entity"}},"description":"A topic entity","x-class-extra-annotation":"@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true)"},"IntentTopicLookup":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"IntentTopic","pattern":"IntentTopic"},"attributes":{"allOf":[{"$ref":"#/components/schemas/TopicEntityModelAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the intent topic"},"JobFunctionLookup":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"JobFunction","pattern":"JobFunction"},"attributes":{"allOf":[{"$ref":"#/components/schemas/BasicEntityModelAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the job function"},"OrderedEntityModelAttributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the entity"},"order":{"type":"string","description":"The ranking order of the entity"}},"description":"An ordered entity","x-class-extra-annotation":"@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true)"},"JobTitleLookup":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"JobTitle","pattern":"JobTitle"},"attributes":{"allOf":[{"$ref":"#/components/schemas/OrderedEntityModelAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the job title hierarchy"},"ManagementLevelLookup":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"ManagementLevel","pattern":"ManagementLevel"},"attributes":{"allOf":[{"$ref":"#/components/schemas/BasicEntityModelAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the management level"},"MetroRegionLookup":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"MetroRegion","pattern":"MetroRegion"},"attributes":{"allOf":[{"$ref":"#/components/schemas/BasicEntityModelAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for a metro region"},"NAICSCodeLookup":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"NAICSCode","pattern":"NAICSCode"},"attributes":{"allOf":[{"$ref":"#/components/schemas/BasicEntityModelAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the NAICS code"},"NewsCategoryLookup":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"NewsCategory","pattern":"NewsCategory"},"attributes":{"allOf":[{"$ref":"#/components/schemas/BasicEntityModelAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the news category"},"RevenueRangeLookup":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"RevenueRange","pattern":"RevenueRange"},"attributes":{"allOf":[{"$ref":"#/components/schemas/BasicEntityModelAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for revenue ranges. Values are in $1,000s"},"ScoopDepartmentLookup":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"ScoopDepartment","pattern":"ScoopDepartment"},"attributes":{"allOf":[{"$ref":"#/components/schemas/BasicEntityModelAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the scoop department"},"ScoopTopicLookup":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"ScoopTopic","pattern":"ScoopTopic"},"attributes":{"allOf":[{"$ref":"#/components/schemas/BasicEntityModelAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the scoop topic"},"ScoopTypeLookup":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"ScoopType","pattern":"ScoopType"},"attributes":{"allOf":[{"$ref":"#/components/schemas/BasicEntityModelAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the scoop type"},"SICCodeLookup":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"SICCode","pattern":"SICCode"},"attributes":{"allOf":[{"$ref":"#/components/schemas/BasicEntityModelAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the SIC code"},"StateLookup":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"State","pattern":"State"},"attributes":{"allOf":[{"$ref":"#/components/schemas/BasicEntityModelAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for a state"},"SubUnitTypeLookup":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"SubUnitType","pattern":"SubUnitType"},"attributes":{"allOf":[{"$ref":"#/components/schemas/BasicEntityModelAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for sub unit types"},"TechCategoryEntityModelAttributes":{"type":"object","required":["categories"],"properties":{"categories":{"type":"array","items":{"type":"string"},"description":"The names of the tech categories"}},"description":"An entity with additional array attributes","x-class-extra-annotation":"@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true)"},"TechCategoryLookup":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"TechCategory","pattern":"TechCategory"},"attributes":{"allOf":[{"$ref":"#/components/schemas/TechCategoryEntityModelAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the tech category, the attribute is the parent category"},"AttributedEntityModelAttributes":{"type":"object","required":["name"],"properties":{"attribute":{"type":"string","description":"An attribute of the entity"},"name":{"type":"string","description":"The name of the entity"}},"description":"An entity with additional attributes","x-class-extra-annotation":"@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true)"},"TechProductLookup":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"TechProduct","pattern":"TechProduct"},"attributes":{"allOf":[{"$ref":"#/components/schemas/AttributedEntityModelAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the tech product, the attribute is the product's full coded id 'vendorId.parentCategoryId.categoryId.productId'"},"TechSkillLookup":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"TechSkill","pattern":"TechSkill"},"attributes":{"allOf":[{"$ref":"#/components/schemas/BasicEntityModelAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the tech skill"},"TechVendorLookup":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"TechVendor","pattern":"TechVendor"},"attributes":{"allOf":[{"$ref":"#/components/schemas/BasicEntityModelAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the tech vendor"},"YearsOfExperienceLookup":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"YearsOfExperience","pattern":"YearsOfExperience"},"attributes":{"allOf":[{"$ref":"#/components/schemas/BasicEntityModelAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the years of experience"},"LookupResponseResourceUnion":{"type":"object","oneOf":[{"$ref":"#/components/schemas/BoardMemberLookup"},{"$ref":"#/components/schemas/BuyingGroupLookup"},{"$ref":"#/components/schemas/CompanyRankingLookup"},{"$ref":"#/components/schemas/CompanyTypeLookup"},{"$ref":"#/components/schemas/ContinentLookup"},{"$ref":"#/components/schemas/CountryLookup"},{"$ref":"#/components/schemas/DepartmentLookup"},{"$ref":"#/components/schemas/EmployeeCountLookup"},{"$ref":"#/components/schemas/HashtagLookup"},{"$ref":"#/components/schemas/IndustryLookup"},{"$ref":"#/components/schemas/IntentTopicLookup"},{"$ref":"#/components/schemas/JobFunctionLookup"},{"$ref":"#/components/schemas/JobTitleLookup"},{"$ref":"#/components/schemas/ManagementLevelLookup"},{"$ref":"#/components/schemas/MetroRegionLookup"},{"$ref":"#/components/schemas/NAICSCodeLookup"},{"$ref":"#/components/schemas/NewsCategoryLookup"},{"$ref":"#/components/schemas/RevenueRangeLookup"},{"$ref":"#/components/schemas/ScoopDepartmentLookup"},{"$ref":"#/components/schemas/ScoopTopicLookup"},{"$ref":"#/components/schemas/ScoopTypeLookup"},{"$ref":"#/components/schemas/SICCodeLookup"},{"$ref":"#/components/schemas/StateLookup"},{"$ref":"#/components/schemas/SubUnitTypeLookup"},{"$ref":"#/components/schemas/TechCategoryLookup"},{"$ref":"#/components/schemas/TechProductLookup"},{"$ref":"#/components/schemas/TechSkillLookup"},{"$ref":"#/components/schemas/TechVendorLookup"},{"$ref":"#/components/schemas/YearsOfExperienceLookup"}],"discriminator":{"propertyName":"type","mapping":{"BoardMember":"#/components/schemas/BoardMemberLookup","BuyingGroup":"#/components/schemas/BuyingGroupLookup","CompanyRanking":"#/components/schemas/CompanyRankingLookup","CompanyType":"#/components/schemas/CompanyTypeLookup","Continent":"#/components/schemas/ContinentLookup","Country":"#/components/schemas/CountryLookup","Department":"#/components/schemas/DepartmentLookup","EmployeeCount":"#/components/schemas/EmployeeCountLookup","Hashtag":"#/components/schemas/HashtagLookup","Industry":"#/components/schemas/IndustryLookup","IntentTopic":"#/components/schemas/IntentTopicLookup","JobFunction":"#/components/schemas/JobFunctionLookup","JobTitle":"#/components/schemas/JobTitleLookup","ManagementLevel":"#/components/schemas/ManagementLevelLookup","MetroRegion":"#/components/schemas/MetroRegionLookup","NAICSCode":"#/components/schemas/NAICSCodeLookup","NewsCategory":"#/components/schemas/NewsCategoryLookup","RevenueRange":"#/components/schemas/RevenueRangeLookup","ScoopDepartment":"#/components/schemas/ScoopDepartmentLookup","ScoopTopic":"#/components/schemas/ScoopTopicLookup","ScoopType":"#/components/schemas/ScoopTypeLookup","SICCode":"#/components/schemas/SICCodeLookup","State":"#/components/schemas/StateLookup","SubUnitType":"#/components/schemas/SubUnitTypeLookup","TechCategory":"#/components/schemas/TechCategoryLookup","TechProduct":"#/components/schemas/TechProductLookup","TechSkill":"#/components/schemas/TechSkillLookup","TechVendor":"#/components/schemas/TechVendorLookup","YearsOfExperience":"#/components/schemas/YearsOfExperienceLookup"}}},"LookupResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LookupResponseResourceUnion"},"description":"The primary data of the document"}},"description":"Lookup response"},"SearchEntityNameEnum":{"type":"string","enum":["company","contact","scoop","news","intent"],"description":"All possible search lookup field names","x-enumDescriptions":{"company":"Returns a list of fields you can use as input or output for the Company Search endpoint.","contact":"Returns a list of fields you can use as input or output for the Contact Search endpoint.","scoop":"Returns a list of fields you can use as input or output for the Scoop Search endpoint.","news":"Returns a list of fields you can use as input or output for the News Search endpoint.","intent":"Returns a list of fields you can use as input or output for the Intent Search endpoint."}},"FieldTypeEnum":{"type":"string","enum":["input","output"],"x-enumDescriptions":{"input":"Returns a list of fields you can use as input for supported entity types.","output":"Returns a list of fields you can use as output for supported entity types."}},"LookupFieldAttributes":{"type":"object","required":["fieldName","description"],"properties":{"fieldType":{"type":"string","description":"The type of the input lookup field e.g: Long or String"},"fieldName":{"type":"string","description":"The name of the lookup field"},"description":{"type":"string","description":"The description of the lookup field"},"accessGranted":{"type":"boolean","description":"The access level of the lookup field is currently limited to input fields and is not available for output fields."}},"description":"Common attributes for lookup fields, used in both input and output lookups."},"ContactSearchInputLookUp":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"ContactSearchInput","pattern":"ContactSearchInput"},"attributes":{"allOf":[{"$ref":"#/components/schemas/LookupFieldAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the contact search input lookup"},"CompanySearchInputLookUp":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"CompanySearchInput","pattern":"CompanySearchInput"},"attributes":{"allOf":[{"$ref":"#/components/schemas/LookupFieldAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the company search input lookup"},"NewsSearchInputLookUp":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"NewsSearchInput","pattern":"NewsSearchInput"},"attributes":{"allOf":[{"$ref":"#/components/schemas/LookupFieldAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the news search input lookup"},"IntentSearchInputLookUp":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"IntentSearchInput","pattern":"IntentSearchInput"},"attributes":{"allOf":[{"$ref":"#/components/schemas/LookupFieldAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the intent search input lookup"},"ScoopSearchInputLookUp":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"ScoopSearchInput","pattern":"ScoopSearchInput"},"attributes":{"allOf":[{"$ref":"#/components/schemas/LookupFieldAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the scoop search input lookup"},"ContactSearchOutputLookUp":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"ContactSearchOutput","pattern":"ContactSearchOutput"},"attributes":{"allOf":[{"$ref":"#/components/schemas/LookupFieldAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the contact search output lookup"},"CompanySearchOutputLookUp":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"CompanySearchOutput","pattern":"CompanySearchOutput"},"attributes":{"allOf":[{"$ref":"#/components/schemas/LookupFieldAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the company search output lookup"},"NewsSearchOutputLookUp":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"NewsSearchOutput","pattern":"NewsSearchOutput"},"attributes":{"allOf":[{"$ref":"#/components/schemas/LookupFieldAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the news search output lookup"},"IntentSearchOutputLookUp":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"IntentSearchOutput","pattern":"IntentSearchOutput"},"attributes":{"allOf":[{"$ref":"#/components/schemas/LookupFieldAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the intent search output lookup"},"ScoopSearchOutputLookUp":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"ScoopSearchOutput","pattern":"ScoopSearchOutput"},"attributes":{"allOf":[{"$ref":"#/components/schemas/LookupFieldAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the scoop search output lookup"},"LookupSearchInputOutputResponseResourceUnion":{"type":"object","oneOf":[{"$ref":"#/components/schemas/ContactSearchInputLookUp"},{"$ref":"#/components/schemas/CompanySearchInputLookUp"},{"$ref":"#/components/schemas/NewsSearchInputLookUp"},{"$ref":"#/components/schemas/IntentSearchInputLookUp"},{"$ref":"#/components/schemas/ScoopSearchInputLookUp"},{"$ref":"#/components/schemas/ContactSearchOutputLookUp"},{"$ref":"#/components/schemas/CompanySearchOutputLookUp"},{"$ref":"#/components/schemas/NewsSearchOutputLookUp"},{"$ref":"#/components/schemas/IntentSearchOutputLookUp"},{"$ref":"#/components/schemas/ScoopSearchOutputLookUp"}],"discriminator":{"propertyName":"type","mapping":{"ContactSearchInput":"#/components/schemas/ContactSearchInputLookUp","CompanySearchInput":"#/components/schemas/CompanySearchInputLookUp","NewsSearchInput":"#/components/schemas/NewsSearchInputLookUp","IntentSearchInput":"#/components/schemas/IntentSearchInputLookUp","ScoopSearchInput":"#/components/schemas/ScoopSearchInputLookUp","ContactSearchOutput":"#/components/schemas/ContactSearchOutputLookUp","CompanySearchOutput":"#/components/schemas/CompanySearchOutputLookUp","NewsSearchOutput":"#/components/schemas/NewsSearchOutputLookUp","IntentSearchOutput":"#/components/schemas/IntentSearchOutputLookUp","ScoopSearchOutput":"#/components/schemas/ScoopSearchOutputLookUp"}},"description":"Represents the possible resource types returned in a lookup search input response."},"LookupSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LookupSearchInputOutputResponseResourceUnion"},"description":"The primary data of the document"}},"description":"Lookup search output response"},"EnrichEntityNameEnum":{"type":"string","enum":["company","contact","scoop","news","intent","technology","hashtag","orgChart","corporate-hierarchy"],"description":"All possible enrich lookup field names","x-enumDescriptions":{"company":"Returns a list of fields you can use as input or output for the Company Enrich endpoint.","contact":"Returns a list of fields you can use as input or output for the Contact Enrich endpoint.","scoop":"Returns a list of fields you can use as input or output for the Scoop Enrich endpoint.","news":"Returns a list of fields you can use as input or output for the News Enrich endpoint.","intent":"Returns a list of fields you can use as input or output for the Intent Enrich endpoint.","technology":"Returns a list of fields you can use as input or output for the Company Technology Enrich endpoint.","hashtag":"Returns a list of fields you can use as input or output for the Company Hashtag Enrich endpoint.","orgChart":"Returns a list of fields you can use as input or output for the Company OrgChart Enrich endpoint.","corporateHierarchy":"Returns a list of fields you can use as input or output for the Company CorporateHierarchy Enrich endpoint."}},"ContactEnrichInputLookUp":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"ContactEnrichInput","pattern":"ContactEnrichInput"},"attributes":{"allOf":[{"$ref":"#/components/schemas/LookupFieldAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the contact search enrich lookup"},"CompanyEnrichInputLookUp":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"CompanyEnrichInput","pattern":"CompanyEnrichInput"},"attributes":{"allOf":[{"$ref":"#/components/schemas/LookupFieldAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the company enrich  input lookup"},"NewsEnrichInputLookUp":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"NewsEnrichInput","pattern":"NewsEnrichInput"},"attributes":{"allOf":[{"$ref":"#/components/schemas/LookupFieldAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the news enrich input lookup"},"IntentEnrichInputLookUp":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"IntentEnrichInput","pattern":"IntentEnrichInput"},"attributes":{"allOf":[{"$ref":"#/components/schemas/LookupFieldAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the intent enrich input lookup"},"ScoopEnrichInputLookUp":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"ScoopEnrichInput","pattern":"ScoopEnrichInput"},"attributes":{"allOf":[{"$ref":"#/components/schemas/LookupFieldAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the scoop enrich input lookup"},"TechnologyEnrichInputLookUp":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"TechnologyEnrichInput","pattern":"TechnologyEnrichInput"},"attributes":{"allOf":[{"$ref":"#/components/schemas/LookupFieldAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the technology enrich input lookup"},"HashtagEnrichInputLookUp":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"HashtagEnrichInput","pattern":"HashtagEnrichInput"},"attributes":{"allOf":[{"$ref":"#/components/schemas/LookupFieldAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the hashtag enrich input lookup"},"OrgChartEnrichInputLookUp":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"OrgChartEnrichInput","pattern":"OrgChartEnrichInput"},"attributes":{"allOf":[{"$ref":"#/components/schemas/LookupFieldAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the orgChart enrich input lookup"},"CorporateHierarchyEnrichInputLookUp":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"CorporateHierarchyEnrichInput","pattern":"CorporateHierarchyEnrichInput"},"attributes":{"allOf":[{"$ref":"#/components/schemas/LookupFieldAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the corporate hierarchy enrich input lookup"},"ContactEnrichOutputLookUp":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"ContactEnrichOutput","pattern":"ContactEnrichOutput"},"attributes":{"allOf":[{"$ref":"#/components/schemas/LookupFieldAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the contact enrich output lookup"},"CompanyEnrichOutputLookUp":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"CompanyEnrichOutput","pattern":"CompanyEnrichOutput"},"attributes":{"allOf":[{"$ref":"#/components/schemas/LookupFieldAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the company enrich output lookup"},"NewsEnrichOutputLookUp":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"NewsEnrichOutput","pattern":"NewsEnrichOutput"},"attributes":{"allOf":[{"$ref":"#/components/schemas/LookupFieldAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the news enrich output lookup"},"IntentEnrichOutputLookUp":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"IntentEnrichOutput","pattern":"IntentEnrichOutput"},"attributes":{"allOf":[{"$ref":"#/components/schemas/LookupFieldAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the intent enrich output lookup"},"ScoopEnrichOutputLookUp":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"ScoopEnrichOutput","pattern":"ScoopEnrichOutput"},"attributes":{"allOf":[{"$ref":"#/components/schemas/LookupFieldAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the scoop enrich output lookup"},"TechnologyEnrichOutputLookUp":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"TechnologyEnrichOutput","pattern":"TechnologyEnrichOutput"},"attributes":{"allOf":[{"$ref":"#/components/schemas/LookupFieldAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the technology enrich output lookup"},"HashtagEnrichOutputLookUp":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"HashtagEnrichOutput","pattern":"HashtagEnrichOutput"},"attributes":{"allOf":[{"$ref":"#/components/schemas/LookupFieldAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the technology enrich output lookup"},"OrgChartEnrichOutputLookUp":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"OrgChartEnrichOutput","pattern":"OrgChartEnrichOutput"},"attributes":{"allOf":[{"$ref":"#/components/schemas/LookupFieldAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the org chart enrich output lookup"},"CorporateHierarchyEnrichOutputLookUp":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"CorporateHierarchyEnrichOutput","pattern":"CorporateHierarchyEnrichOutput"},"attributes":{"allOf":[{"$ref":"#/components/schemas/LookupFieldAttributes"}],"description":"The attributes defining the resource"}},"description":"Model for the corporate hierarchy enrich output lookup"},"LookupEnrichInputOutputResponseResourceUnion":{"type":"object","oneOf":[{"$ref":"#/components/schemas/ContactEnrichInputLookUp"},{"$ref":"#/components/schemas/CompanyEnrichInputLookUp"},{"$ref":"#/components/schemas/NewsEnrichInputLookUp"},{"$ref":"#/components/schemas/IntentEnrichInputLookUp"},{"$ref":"#/components/schemas/ScoopEnrichInputLookUp"},{"$ref":"#/components/schemas/TechnologyEnrichInputLookUp"},{"$ref":"#/components/schemas/HashtagEnrichInputLookUp"},{"$ref":"#/components/schemas/OrgChartEnrichInputLookUp"},{"$ref":"#/components/schemas/CorporateHierarchyEnrichInputLookUp"},{"$ref":"#/components/schemas/ContactEnrichOutputLookUp"},{"$ref":"#/components/schemas/CompanyEnrichOutputLookUp"},{"$ref":"#/components/schemas/NewsEnrichOutputLookUp"},{"$ref":"#/components/schemas/IntentEnrichOutputLookUp"},{"$ref":"#/components/schemas/ScoopEnrichOutputLookUp"},{"$ref":"#/components/schemas/TechnologyEnrichOutputLookUp"},{"$ref":"#/components/schemas/HashtagEnrichOutputLookUp"},{"$ref":"#/components/schemas/OrgChartEnrichOutputLookUp"},{"$ref":"#/components/schemas/CorporateHierarchyEnrichOutputLookUp"}],"discriminator":{"propertyName":"type","mapping":{"ContactEnrichInput":"#/components/schemas/ContactEnrichInputLookUp","CompanyEnrichInput":"#/components/schemas/CompanyEnrichInputLookUp","NewsEnrichInput":"#/components/schemas/NewsEnrichInputLookUp","IntentEnrichInput":"#/components/schemas/IntentEnrichInputLookUp","ScoopEnrichInput":"#/components/schemas/ScoopEnrichInputLookUp","TechnologyEnrichInput":"#/components/schemas/TechnologyEnrichInputLookUp","HashtagEnrichInput":"#/components/schemas/HashtagEnrichInputLookUp","OrgChartEnrichInput":"#/components/schemas/OrgChartEnrichInputLookUp","CorporateHierarchyEnrichInput":"#/components/schemas/CorporateHierarchyEnrichInputLookUp","ContactEnrichOutput":"#/components/schemas/ContactEnrichOutputLookUp","CompanyEnrichOutput":"#/components/schemas/CompanyEnrichOutputLookUp","NewsEnrichOutput":"#/components/schemas/NewsEnrichOutputLookUp","IntentEnrichOutput":"#/components/schemas/IntentEnrichOutputLookUp","ScoopEnrichOutput":"#/components/schemas/ScoopEnrichOutputLookUp","TechnologyEnrichOutput":"#/components/schemas/TechnologyEnrichOutputLookUp","HashtagEnrichOutput":"#/components/schemas/HashtagEnrichOutputLookUp","OrgChartEnrichOutput":"#/components/schemas/OrgChartEnrichOutputLookUp","CorporateHierarchyEnrichOutput":"#/components/schemas/CorporateHierarchyEnrichOutputLookUp"}},"description":"Represents the possible resource types returned in a lookup enrich input response."},"LookupEnrichResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LookupEnrichInputOutputResponseResourceUnion"},"description":"The primary data of the document"}},"description":"Lookup enrich output response"},"UserUsageModel":{"type":"object","properties":{"limitType":{"type":"string","description":"Type of limit. Options are request, record, uniqueID, webSightsApiRequest, and webSightsApiRecord."},"description":{"type":"string","description":"Description of the limit type."},"totalLimit":{"type":"integer","format":"int64","description":"The number of this type of request you are subscribed for. This is generally an usage limit for a contract period."},"currentUsage":{"type":"integer","format":"int64","description":"The number of this type of request you have already used."},"usageRemaining":{"type":"integer","format":"int64","description":"The remaining number of this type of request you can make before requiring additional purchase."}},"description":"Model containing information about usage data"},"UserUsageAttributes":{"type":"object","required":["usage"],"properties":{"usage":{"type":"array","items":{"$ref":"#/components/schemas/UserUsageModel"},"description":"List of usage data"}},"description":"Attributes describing user usage"},"UsageResponseResource":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"UserUsage","pattern":"UserUsage"},"attributes":{"allOf":[{"$ref":"#/components/schemas/UserUsageAttributes"}],"description":"The attributes defining the resource"}},"description":"Usage response."},"UsageResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/UsageResponseResource"},"description":"The primary data of the document"}},"description":"Usage response."},"CommonSearchRequestAttributes":{"type":"object","properties":{"companyTicker":{"type":"array","items":{"type":"string"},"description":"Company stock ticker symbol."},"companyDescription":{"type":"string","description":"Search for companies based on description. Accepts a space-separated list of individual words."},"companyType":{"type":"string","description":"Company type (private, public, etc.). Accepts a comma-separated list of types."},"address":{"type":"string","description":"Full Company Address."},"street":{"type":"string","description":"Street address portion of the company's location."},"state":{"type":"string","description":"State or province of the company's address."},"zipCode":{"type":"string","description":"Zip Code or Postal Code of the company's address."},"country":{"type":"string","description":"Country of the primary address of the associated company."},"continent":{"type":"string","description":"Continent of the primary address of the associated company."},"zipCodeRadiusMiles":{"type":"integer","format":"int16","description":"Used in conjunction with zipCode, designates a geographical radius (in miles) from the zipCode provided. Supported values are [10, 25, 50, 100, 250]"},"hashTagString":{"type":"string","description":"Hash tags for a company. Can include a comma-separated list."},"techAttributeTagList":{"type":"string","description":"Technology Product Tags. Can include a comma-separated list."},"primaryIndustriesOnly":{"type":"boolean","description":"Default is false. 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."},"subUnitTypes":{"type":"string","description":"Company sub types (e.g., division, subsidiary). Use this in conjunction with parentId or ultimateParentId."},"industryCodes":{"type":"string","description":"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."},"industryKeywords":{"type":"string","description":"Industry keywords associated with a company. Can include either 'AND' or 'OR' operators. For example, 'software AND security' or 'software OR security'"},"sicCodes":{"type":"string","description":"The Standard Industrial Classification is a system for classifying industries by a four-digit code numerical assigned by the U.S. government to business establishments to identify the primary business of the establishment. Accepts a comma-separated list."},"naicsCodes":{"type":"string","description":"Four-digit numerical codes assigned by the U.S. government to business establishments to identify the primary business of the establishment. Accepts a comma-separated list of values."},"revenue":{"type":"string","description":"Annual revenue range in U.S. dollars. Accepts a comma-separated list of values."},"revenueMin":{"type":"integer","format":"int32","description":"Minimum annual revenue for a company in U.S. dollars (expressed in thousands). Use with revenueMax to set a range."},"revenueMax":{"type":"integer","format":"int32","description":"Maximum annual revenue for a company in U.S. dollars (expressed in thousands). Use with revenueMin to set a range."},"employeeRangeMin":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"Employee count range. Accepts a comma-separated list of values. Alternatively, for more granular ranges, you can use the employeeRangeMin and employeeRangeMax parameters."},"companyRanking":{"type":"string","description":"Company ranking (e.g., Fortune 500). Accepts a comma-separated list of IDs."},"metroRegion":{"type":"string","description":"Company metro area. Accepts a comma-separated list of U.S. and Canada metro areas."},"locationSearchType":{"type":"string","description":"Location type (PersonOrHQ, PersonAndHQ, Person, HQ, PersonThenHQ)."},"fundingAmountMin":{"type":"integer","format":"int32","description":"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":{"type":"integer","format":"int32","description":"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":{"type":"string","format":"date","description":"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":{"type":"string","format":"date","description":"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."},"zoominfoContactsMin":{"type":"string","description":"Minimum number of ZoomInfo contacts associated with company."},"zoominfoContactsMax":{"type":"string","description":"Maximum number of ZoomInfo contacts associated with company."},"excludedRegions":{"type":"string","description":"Accepts a comma-separated list of U.S. and Canada states and metro areas. Companies from any of these regions will be excluded from search results."},"companyStructureIncludedSubUnitTypes":{"type":"string","description":"Company hierarchical structure values. Accepts a comma-separated list of values from 'UNSPECIFIED', 'LOCATION', 'DIVISION', 'ACQUISITION', 'SUBSIDIARY', 'FORMER_NEW_NAME'."},"oneYearEmployeeGrowthRateMin":{"type":"string","description":"Minimum one year employee growth rate for a company. Use with oneYearEmployeeGrowthRateMax to set a range."},"oneYearEmployeeGrowthRateMax":{"type":"string","description":"Maximum one year employee growth rate for a company. Use with oneYearEmployeeGrowthRateMin to set a range."},"twoYearEmployeeGrowthRateMin":{"type":"string","description":"Minimum two year employee growth rate for a company. Use with twoYearEmployeeGrowthRateMax to set a range."},"twoYearEmployeeGrowthRateMax":{"type":"string","description":"Maximum two year employee growth rate for a company. Use with twoYearEmployeeGrowthRateMin to set a range."}},"description":"Common request attributes for search requests."},"CompanyAndContactSearchRequestAttributes":{"type":"object","properties":{"parentId":{"type":"string","description":"ZoomInfo Company ID for parent company."},"ultimateParentId":{"type":"string","description":"Company sub types (e.g., division, subsidiary). Use this in conjunction with parentId or ultimateParentId."},"companyId":{"type":"string","description":"Unique ZoomInfo identifier for a company."},"companyName":{"type":"string","description":"Company name."},"companyWebsite":{"type":"string","description":"Company website URL in http://www.example.com format. Accepts a comma-separated list."},"engagementStartDate":{"type":"string","format":"date","description":"Engagement start date in YYYY-MM-DD format."},"engagementEndDate":{"type":"string","format":"date","description":"Engagement end date in YYYY-MM-DD format. EngagementStartDate is required."},"engagementType":{"type":"array","items":{"type":"string"},"description":"List of engagement types to search for. Accepted values are 'email', 'phone', 'online meeting'. Accepts a comma-separated list of these values."},"excludeTechAttributeTagList":{"type":"string","description":"Exclude companies with these technology product tags. String can be one value ('131315') or a comma-separated list which is treated as OR logic ('131315, 132222'). Individual values can also include AND logic ('131315 AND 131301, 132222'). This last example would be evaluated as ((131201 AND 131301) OR 132222)."}},"description":"Common request attributes for company and contact search requests."},"IntentRequestAttributes":{"type":"object","required":["topics"],"properties":{"topics":{"type":"array","items":{"type":"string"},"description":"Intent topics. Accepts an Array of up to 50 Strings. See the 'Intent Topics' Lookup endpoint for values."},"signalStartDate":{"type":"string","format":"date","description":"Start date for a company signaling interest in a topic. Uses YYYY-MM-DD format."},"signalEndDate":{"type":"string","format":"date","description":"End date for a company signaling interest in a topic. Uses YYYY-MM-DD format."},"signalScoreMin":{"type":"integer","format":"int32","description":"Minimum signal score. Use with signalScoreMax to form a range. Minimum score is 60 and maximum is 100."},"signalScoreMax":{"type":"integer","format":"int32","description":"Maximum signal score. Use with signalScoreMin to form a range. Minimum score is 60 and maximum is 100."},"audienceStrengthMin":{"type":"string","description":"Minimum audience strength score. Use with audienceStrengthMax to form a range. Values are A, B, C, D, and E, with A indicating a larger audience."},"audienceStrengthMax":{"type":"string","description":"Maximum audience strength score. Use with audienceStrengthMin to form a range. Values are A, B, C, D, and E, with A indicating a larger audience."},"findRecommendedContacts":{"type":"boolean","description":"Default is true. Set to false to exclude recommended contacts from results."}},"description":"Request attributes for intent."},"IntentResponseAttributes":{"type":"object","properties":{"category":{"type":"string","description":"Intent category."},"topic":{"type":"string","description":"Intent topic."},"signalScore":{"type":"integer","format":"int32","description":"Signal score for the topic."},"audienceStrength":{"type":"string","description":"Audience strength for the topic."},"signalDate":{"type":"string","format":"date-time","description":"Date the signal was identified."},"company":{"allOf":[{"$ref":"#/components/schemas/IntentCompany"}],"description":"Company data for the intent topic."},"recommendedContacts":{"type":"array","items":{"$ref":"#/components/schemas/RecommendedContact"},"description":"Suggested contacts at the company that are related to the intent topic."},"spikesInDateRange":{"type":"integer","format":"int32","description":"The total number of intent signals detected during your specified timeframe."}},"description":"Attributes of a single intent result."},"ScoopRequestCommonAttributes":{"type":"object","properties":{"publishedStartDate":{"type":"string","format":"date","description":"Starting date to search for scoops based on publication date. Form a range using publishedEndDate or omit publishedEndDate to search to the current date. Uses YYYY-MM-DD format."},"publishedEndDate":{"type":"string","format":"date","description":"Ending date to search for scoops based on publication date. Form a range using publishedStartDate. Uses YYYY-MM-DD format."},"updatedSinceCreation":{"type":"boolean","description":"Default is false. Setting true will only return scoops that have been updated since publishedStartDate."},"scoopType":{"type":"string","description":"Retrieve scoops based on type (e.g. earnings, awards and partnerships). Accepts a comma-separated list of IDs from the lookup endpoint."},"scoopTopic":{"type":"string","description":"Retrieve scoops based on topic (e.g. integration, consolidation and compliance). Accepts a comma-separated list of IDs from the lookup endpoint."},"department":{"type":"string","description":"Retrieve scoops based on department (IT, finance, HR and so on). See the Scoop Departments lookup endpoint for valid inputs.."},"scoopId":{"type":"string","description":"ZoomInfo unique identifier for a Scoop. Accepts a comma-separated list."},"description":{"type":"string","description":"Search for scoops based on description.  Accepts a space-separated list of individual words."}},"description":"Scoop common request attributes."},"ScoopRequestContactAttributes":{"type":"object","properties":{"businessModel":{"type":"array","items":{"type":"string"},"description":"Search using Business Model (B2C, B2B, B2G) for a company. Default is All."},"personId":{"type":"string","description":"Unique ZoomInfo identifier for the contact. Can include a comma-separated list."},"emailAddress":{"type":"string","description":"Email address for the contact in example@example.com format."},"hashedEmail":{"type":"string","description":"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."},"fullName":{"type":"string","description":"Contact full name."},"firstName":{"type":"string","description":"Contact first name."},"middleInitial":{"type":"string","description":"Contact middle initial."},"lastName":{"type":"string","description":"Contact last name."},"jobTitle":{"type":"string","description":"Contact job title at current place of employment."},"exactJobTitle":{"type":"string","description":"Contact title at current place of employment using exact match logic. Use OR to input multiple job titles."},"excludeJobTitle":{"type":"string","description":"Comma-separated list of job titles to exclude from search results."},"managementLevel":{"type":"string","description":"Contact management level at current place of employment."},"excludeManagementLevel":{"type":"string","description":"Comma separated list of management levels to exclude from search results."},"boardMember":{"type":"string","description":"Exclude or include board members from search results. Default behavior is to exclude board members from search results. Submit this as “include” to include board members, set this as “only” to only include board members.."},"excludePartialProfiles":{"type":"boolean","description":"Defaults to false. To include partial profiles in your search results, set this to true. Contacts who do not have an active company associated with them are considered partial profiles."},"executivesOnly":{"type":"boolean","description":"Defaults to false. Set this to true to include only Executives in search results."},"requiredFields":{"type":"string","description":"Specify the fields that must be present for a record to return. Accepts a comma-separated list."},"contactAccuracyScoreMin":{"type":"string","description":"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."},"contactAccuracyScoreMax":{"type":"string","description":"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."},"jobFunction":{"type":"string","description":"Contact job function at their current place of employment."},"lastUpdatedInMonths":{"type":"integer","format":"int32","description":"Number of months within which the contact's profile was last updated."},"hasBeenNotified":{"type":"string","description":"Defaults to include. Set this to “exclude” to exclude contacts who have been notified of inclusion in ZoomInfo's database. Set this to “only” to only include contacts who have been notified."},"companyPastOrPresent":{"type":"string","description":"Defaults to only include the present company for a contact. Set this to “past” to return past companies, set this to “pastAndPresent” to include both."},"school":{"type":"string","description":"School name."},"degree":{"type":"string","description":"Searches by contact's education."},"locationCompanyId":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Searches by contact's locationIds."},"certified":{"type":"integer","format":"int32","description":"Denotes if ZoomInfo's research and data team has confirmed activity within the past 12 months. 1 = certified, 0 = not certified."}},"description":"Scoop search contact attributes."},"ScoopResponseCommonAttributes":{"type":"object","properties":{"id":{"type":"string","description":"ZoomInfo unique identifier for a scoop."},"publishedDate":{"type":"string","format":"date-time","description":"Date when a scoop was published."},"originalPublishedDate":{"type":"string","format":"date-time","description":"Date when a scoop was originally published."},"linkText":{"type":"string","description":"Link text for a scoop."},"link":{"type":"string","description":"URL for a scoop."},"description":{"type":"string","description":"Description associated with the scoop"},"topics":{"type":"array","items":{"type":"object","additionalProperties":{}},"description":"Scoop topics."},"updateText":{"type":"string","description":"Text related to an updated scoop."},"types":{"type":"array","items":{"type":"object","additionalProperties":{}},"description":"Types associated with a scoop."},"company":{"allOf":[{"$ref":"#/components/schemas/ScoopCompany"}],"description":"Company"},"contacts":{"type":"array","items":{"$ref":"#/components/schemas/ScoopContact"},"description":"Contacts associated with a scoop."}},"description":"Scoop common response attributes."},"CommonEnrichRequestAttributes":{"type":"object","properties":{"companyId":{"type":"integer","format":"int64","description":"Unique ZoomInfo identifier for a company."},"companyName":{"type":"string","description":"Company name."}},"description":"Common attributes for enrich request."},"CommonEnrichResponseAttributes":{"type":"object","properties":{"socialMediaUrls":{"type":"array","items":{"$ref":"#/components/schemas/SocialMediaUrl"},"description":"Social media URLs for the company (e.g., Facebook, Twitter, LinkedIn and so on)."},"primaryIndustry":{"type":"array","items":{"type":"string"},"description":"Top-level industry for a company."},"primaryIndustryCode":{"type":"array","items":{"$ref":"#/components/schemas/PrimaryIndustryCode"},"description":"Top-level industry for a company along with its code."},"primarySubIndustryCode":{"type":"array","items":{"$ref":"#/components/schemas/PrimarySubIndustryCode"},"description":"Top-level sub-industry for a company along with its code."},"industries":{"type":"array","items":{"type":"string"},"description":"The industry grouping for the company. A company can have multiple industries."},"industryCodes":{"type":"array","items":{"$ref":"#/components/schemas/IndustryCode"},"description":"The industry grouping for the company along with it's codes. A company can have multiple industries."},"website":{"type":"string","description":"Company website."},"type":{"type":"string","description":"Company type (private, public, npo, education, government, other)."},"ticker":{"type":"string","description":"Company public stock exchange ticker."},"name":{"type":"string","description":"Company name."},"description":{"type":"string","description":"Description associated with the company."},"phone":{"type":"string","description":"Company phone number."},"fax":{"type":"string","description":"Fax number of the company headquarters."},"street":{"type":"string","description":"Street portion of the company's primary address."},"city":{"type":"string","description":"City of the company's primary address."},"state":{"type":"string","description":"State or province of the company's primary address."},"zipCode":{"type":"string","description":"Zip code or postal code of the company's primary address."},"country":{"type":"string","description":"Country of the company's primary address."},"continent":{"type":"string","description":"Continent of the company's primary address."},"logo":{"type":"string","description":"The URL which can be used to retrieve the logo for the company."},"alternateLogos":{"type":"array","items":{"type":"string"},"description":"List of alternate logos for the company."},"employeeCount":{"type":"integer","format":"int32","description":"Employee count of the company."},"sicCodes":{"type":"array","items":{"$ref":"#/components/schemas/SicCode"},"description":"The Standard Industrial Classification is a system for classifying industries by a four-digit numerical code assigned by the U.S. government to business establishments to identify the primary business of the establishment."},"naicsCodes":{"type":"array","items":{"$ref":"#/components/schemas/NaicsCode"},"description":"Four-digit numerical codes assigned by the U.S. government to business establishments to identify the primary business of the establishment."},"employeeRange":{"type":"string","description":"Employee range at the company."},"employeeGrowth":{"allOf":[{"$ref":"#/components/schemas/EmployeeGrowth"}],"description":"Employee growth rate at the company."},"revenueRange":{"type":"string","description":"Revenue range for a company."}},"description":"Common attributes for enrich response."},"CommonHierarchyInfo":{"type":"object","properties":{"city":{"type":"string","description":"City of the company's primary address."},"state":{"type":"string","description":"State or province of the company's primary address."}},"description":"Common hierarchy information."},"Versions":{"type":"string","enum":["1.0"]}},"securitySchemes":{"OAuth2Auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://login.zoominfo.com","tokenUrl":"https://okta-login.zoominfo.com/oauth2/default/v1/token","scopes":{"api:data:contact":"Ability to search and enrich ZoomInfo Contact data","api:data:company":"Ability to search and enrich ZoomInfo Company data","api:data:intent":"Ability to search and enrich ZoomInfo Intent data","api:data:news":"Ability to search and enrich ZoomInfo News data","api:data:scoops":"Ability to search and enrich ZoomInfo Scoop data","api:data:lookup":"Lookup ZoomInfo Data"}}}}}},"servers":[{"url":"https://api.zoominfo.com/gtm","description":"Base URL for the Data API"}]}