{"openapi":"3.0.3","info":{"title":"Intellizence API","version":"1.0.0","description":"Dataset APIs for structured business-signal records (M&A, layoffs, fundraising,\nexecutive changes, data breaches, business expansion).\n\n**Authentication**: every request must include the `x-api-key` header.\n[Request an API key](https://intellizence.com/api-trial/) ·\n[Schedule a call](https://intellizence.com/schedule-a-demo/) · sales@intellizence.com\n\n**Security Notice**: keep your API key secure. Do not share it in publicly\naccessible areas such as GitHub or client-side code.\n\n**Errors**: this API returns HTTP 200 for both success and domain errors.\nCheck `code` in the response body — `200` means success; `4xx`/`7xx` values are\ndocumented under `ErrorResponse`.\n"},"servers":[{"url":"https://connect.intellizence.com","description":"Production"}],"tags":[{"name":"Dataset API","description":"Structured signal datasets"},{"name":"Company News Signal API","description":"Curated company news signals"},{"name":"Company & Trigger Configuration","description":"Manage the company domains and trigger codes configured on your subscription"},{"name":"Company Tracking API (Deprecated)","description":"Legacy v1 brand APIs — deprecated, kept for existing integrations"}],"paths":{"/api/news":{"post":{"tags":["Company News Signal API"],"summary":"Company News","description":"Returns curated news articles for the given company domain(s), trigger code(s), and published date range. A news record may include clustered or related articles under `similarNews`.\n\nUsers can search data using the following parameters: `companyDomains`, `triggerCodes`, `startDate`, `endDate`, and `limit`. Additional company filters are also supported: `industries`, `stockMarkets`, `companyTypes`, `locations`.\n\nUsers can limit the number of records returned using the `limit` parameter. The default limit is `100`. All parameters are optional.\n\nThe API key must be passed in the HTTP header as `x-api-key`.\n","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewsSearchRequest"},"examples":{"searchLatestNewsSignalsForACompanyDomain":{"summary":"Search Latest News Signals for a Company Domain","value":{"companyDomains":["openai.com"],"limit":1}},"searchNewsSignalsForMultipleCompanyDomains":{"summary":"Search News Signals for Multiple Company Domains","value":{"companyDomains":["openai.com","anthropic.com","databricks.com"],"limit":1}},"searchNewsSignalsWithinADateRange":{"summary":"Search News Signals Within a Date Range","value":{"companyDomains":["openai.com"],"startDate":"2026-01-01","endDate":"2026-01-31","limit":1}},"searchMANewsSignals":{"summary":"Search M&A News Signals","value":{"companyDomains":["openai.com","anthropic.com"],"triggerCodes":["KW_518"],"startDate":"2026-01-01","endDate":"2026-01-31","limit":1}},"searchStartupFundingAndInvestmentSignals":{"summary":"Search Startup Funding and Investment Signals","value":{"companyDomains":["anthropic.com","databricks.com"],"triggerCodes":["KW_514","KW_708"],"startDate":"2026-01-01","endDate":"2026-01-31","limit":1}},"searchLeadershipChangeSignals":{"summary":"Search Leadership Change Signals","value":{"companyDomains":["microsoft.com","salesforce.com"],"triggerCodes":["KW_502","KW_591","KW_536"],"startDate":"2026-01-01","endDate":"2026-01-31","limit":1}},"searchBusinessExpansionAndHiringSignals":{"summary":"Search Business Expansion and Hiring Signals","value":{"companyDomains":["amazon.com","tesla.com"],"triggerCodes":["KW_527","KW_529","KW_640","KW_713"],"startDate":"2026-01-01","endDate":"2026-01-31","limit":1}},"searchLayoffCostCuttingAndRestructuringSignals":{"summary":"Search Layoff, Cost-Cutting, and Restructuring Signals","value":{"companyDomains":["intel.com","cisco.com"],"triggerCodes":["KW_528","KW_687","KW_536"],"startDate":"2026-01-01","endDate":"2026-01-31","limit":1}},"searchProductLaunchSignals":{"summary":"Search Product Launch Signals","value":{"companyDomains":["hubspot.com","shopify.com","stripe.com"],"triggerCodes":["KW_521","KW_566","KW_642"],"startDate":"2026-01-01","endDate":"2026-01-31","limit":1}},"searchAdverseAndNegativeNewsSignals":{"summary":"Search Adverse and Negative News Signals","value":{"companyDomains":["salesforce.com","workday.com","servicenow.com"],"triggerCodes":["KW_528","KW_687","KW_536","KW_584","KW_586","KW_641"],"startDate":"2026-01-01","endDate":"2026-01-31","limit":1}},"dailyCompanyNewsMonitoring":{"summary":"Daily Company News Monitoring","value":{"companyDomains":["openai.com","anthropic.com","databricks.com"],"startDate":"2026-01-01","endDate":"2026-01-31","limit":1}},"salesAndProspectingSignals":{"summary":"Sales and Prospecting Signals","value":{"companyDomains":["openai.com","anthropic.com","databricks.com"],"triggerCodes":["KW_514","KW_708","KW_518","KW_502","KW_591","KW_527","KW_529","KW_512","KW_513","KW_521"],"startDate":"2026-01-01","endDate":"2026-01-31","limit":1}},"customerAccountIntelligenceGrowthAndRiskSignals":{"summary":"Customer / Account Intelligence: Growth and Risk Signals","value":{"companyDomains":["hubspot.com","shopify.com","stripe.com"],"triggerCodes":["KW_514","KW_708","KW_527","KW_529","KW_521","KW_512","KW_502","KW_528","KW_687","KW_536","KW_584","KW_586","KW_641"],"startDate":"2026-01-01","endDate":"2026-01-31","limit":1}},"riskAndAdverseNewsMonitoring":{"summary":"Risk and Adverse News Monitoring","value":{"companyDomains":["salesforce.com","workday.com","servicenow.com"],"triggerCodes":["KW_528","KW_687","KW_536","KW_584","KW_586","KW_641"],"startDate":"2026-01-01","endDate":"2026-01-31","limit":1}},"investmentAndMarketResearch":{"summary":"Investment and Market Research","value":{"companyDomains":["tesla.com","nvidia.com","microsoft.com"],"triggerCodes":["KW_518","KW_514","KW_516","KW_510","KW_688","KW_527","KW_528","KW_536"],"startDate":"2026-01-01","endDate":"2026-01-31","limit":1}},"investmentAndMarketResearch2":{"summary":"Investment and Market Research","value":{"companyDomains":["openai.com"],"limit":1}},"investmentAndMarketResearch3":{"summary":"Investment and Market Research","value":{"companyDomains":["openai.com","anthropic.com","databricks.com"],"limit":1}},"investmentAndMarketResearch4":{"summary":"Investment and Market Research","value":{"triggerCodes":["KW_518","KW_514","KW_528"],"limit":1}},"investmentAndMarketResearch5":{"summary":"Investment and Market Research","value":{"startDate":"2026-01-01","endDate":"2026-01-31","limit":1}},"investmentAndMarketResearch6":{"summary":"Investment and Market Research","value":{"limit":1}},"investmentAndMarketResearch7":{"summary":"Investment and Market Research","value":{"companyDomains":["openai.com","anthropic.com"],"triggerCodes":["KW_518","KW_514"],"startDate":"2026-01-01","endDate":"2026-01-31","limit":1}}}}}},"responses":{"200":{"description":"Successful response — news records.\nAlways check `code` in the body: 200 = success; 4xx/7xx values are business errors returned with HTTP 200 (see the `ErrorResponse` schema for the full code list).\nCredit fields (`openingBalance`, `closingBalance`, `creditsConsumed`) are returned only for Pay-Per-Use billing.\n","content":{"application/json":{"schema":{"type":"object","required":["code","count","news"],"properties":{"code":{"type":"integer","example":200},"count":{"type":"integer","description":"Number of records in `news`."},"news":{"type":"array","items":{"$ref":"#/components/schemas/NewsItem"}},"isTrialAndExpired":{"type":"boolean","description":"Present and true when the caller's trial subscription has expired."},"openingBalance":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credit balance before this request."},"closingBalance":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credit balance after this request."},"creditsConsumed":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credits charged for this request."}}},"example":{"code":200,"count":2,"news":[{"publisher":"Investing.com","title":"Torch Health acquired by OpenAI to boost ChatGPT Health By Investing.com","url":"https://www.investing.com/news/economy-news/torch-health-acquired-by-openai-to-boost-chatgpt-health-93CH-4442961","desc":"Torch Health acquired by OpenAI to boost ChatGPT Health","id":"69a12345f7fd1a188e2b0ea1","triggerNames":["merger & acquisition"],"companyNames":["Torch Health","OpenAI"],"triggerCodes":["KW_518"],"companyDomains":["torch.health","openai.com"],"publishDate":"2026-01-12","similarNews":[{"hash":"b51c77efe01c2eaaaff66ba21d2d4e81","title":"OpenAI buys Torch to bring unified medical data into ChatGPT Health","desc":"OpenAI Group PBC announced today that it had acquired Torch Health Inc., a healthcare technology startup focused on unifying personal medical data.\n","publisher":"SiliconANGLE","url":"https://siliconangle.com/2026/01/12/openai-buys-torch-bring-unified-medical-data-chatgpt-health/","publishDate":"2026-01-12 00:00:00+00:00"}]},{"publisher":"The Information","title":"OpenAI Agrees to Buy AI Healthcare App For About $100 Million","url":"https://www.theinformation.com/articles/openai-agrees-buy-ai-healthcare-app-100-million","desc":"OpenAI has agreed to buy Torch, a one-year-old AI healthcare app, for about $100 million in equity.\n","id":"69a12346f7fd1a188e2b0ea2","triggerNames":["merger & acquisition"],"companyNames":["OpenAI","Torch"],"triggerCodes":["KW_518"],"companyDomains":["openai.com","torch.health"],"publishDate":"2026-01-12","similarNews":[{"hash":"7f215388274c11cbf19f3f39db7065fe","title":"OpenAI acquires health-care technology startup Torch for $60 million","desc":"Torch CEO Ilya Abyzov previously co-founded Forward.","publisher":"CNBC","url":"https://www.cnbc.com/2026/01/12/open-ai-torch-health-care-technology.html","publishDate":"2026-01-12 00:00:00+00:00"}]}]}}}}}}},"/api/v1/group/{group}":{"post":{"tags":["Company Tracking API (Deprecated)"],"deprecated":true,"summary":"Create Group","description":"Creates a named group on your brand used to track companies and triggers.","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"group","in":"path","required":true,"schema":{"type":"string"},"description":"Group name."}],"responses":{"200":{"description":"`{\"status\":200,\"message\":\"OK\"}` on success, `{\"status\":201,\"message\":\"Group name exists\"}` if the group already exists.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"}}}}}},"delete":{"tags":["Company Tracking API (Deprecated)"],"deprecated":true,"summary":"Delete Group","description":"Deletes a group and its tracked companies/triggers.","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"group","in":"path","required":true,"schema":{"type":"string"},"description":"Group name."}],"responses":{"200":{"description":"`{'status':200}` on success, `{'status':404,'message':'Group not found'}` otherwise.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"}}}}}}},"/api/v1/groups":{"get":{"tags":["Company Tracking API (Deprecated)"],"deprecated":true,"summary":"Get All Groups","description":"Returns all group names configured for your brand.","security":[{"ApiKeyAuth":[]}],"responses":{"200":{"description":"List of group names.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","example":200},"message":{"type":"string","example":"OK"},"groups":{"type":"array","items":{"type":"string"},"example":["portfolio","competitors"]}}}}}}}}},"/api/v1/companies":{"get":{"tags":["Company Tracking API (Deprecated)"],"deprecated":true,"summary":"Search Companies","description":"Search the Intellizence company database by partial name and/or domain (at least one required). Returns up to 100 matches.","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"name","in":"query","required":false,"schema":{"type":"string"},"description":"Partial company name."},{"name":"domain","in":"query","required":false,"schema":{"type":"string"},"description":"Partial company domain."}],"responses":{"200":{"description":"Matching companies. `status: 201` with an empty list when neither `name` nor `domain` is sent.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","example":200},"message":{"type":"string","example":"OK"},"companies":{"type":"array","items":{"$ref":"#/components/schemas/CompanyLookup"}}}}}}}}}},"/api/v1/company/{id}":{"get":{"tags":["Company Tracking API (Deprecated)"],"deprecated":true,"summary":"Get Company Details","description":"Returns the enriched Intellizence company profile for a company id (or domain).","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Intellizence company id or domain."}],"responses":{"200":{"description":"Company profile. Body is `{'status':404}` when the company is not found.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","example":200},"company":{"$ref":"#/components/schemas/TrackedCompany"}}}}}}}}},"/api/v1/tracked-companies/{group}":{"get":{"tags":["Company Tracking API (Deprecated)"],"deprecated":true,"summary":"Get Tracked Companies in a Group","description":"Returns the companies tracked under the given group.","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"group","in":"path","required":true,"schema":{"type":"string"},"description":"Group name."}],"responses":{"200":{"description":"Tracked companies for the group.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","example":200},"message":{"type":"string","example":"OK"},"count":{"type":"integer","example":3},"companies":{"type":"array","items":{"$ref":"#/components/schemas/TrackedCompany"}}}}}}}}}},"/api/v1/company/{group}":{"post":{"tags":["Company Tracking API (Deprecated)"],"deprecated":true,"summary":"Add Companies to a Group","description":"Adds companies to a group's tracked list. The group is created if it does not exist. Body accepts `companyIds`, `company_id`, `company_ids`, or `companies` (array or comma-separated string). Adding beyond the plan's max tracked companies is rejected with `status: 201`.","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"group","in":"path","required":true,"schema":{"type":"string"},"description":"Group name."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"companyIds":{"type":"array","items":{"type":"string"},"description":"Intellizence company ids to track.","example":["IN108449","IN036238"]}}},"example":{"companyIds":["IN108449","IN036238"]}}}},"responses":{"200":{"description":"`status: 200` with `addedCompanyIds`; `status: 201`/`400` on limit or group errors.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","example":200},"message":{"type":"string","example":"OK"},"addedCompanyIds":{"type":"array","items":{"type":"string"}}}}}}}}},"delete":{"tags":["Company Tracking API (Deprecated)"],"deprecated":true,"summary":"Remove Companies from a Group","description":"Removes companies from a group's tracked list. Body accepts `companyIds`, `company_id`, `company_ids`, or `companies`.","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"group","in":"path","required":true,"schema":{"type":"string"},"description":"Group name."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"companyIds":{"type":"array","items":{"type":"string"},"example":["IN108449"]}}},"example":{"companyIds":["IN108449"]}}}},"responses":{"200":{"description":"`status: 200` on success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"}}}}}}},"/api/v1/company/{group}/{companyId}":{"post":{"tags":["Company Tracking API (Deprecated)"],"deprecated":true,"summary":"Add a Single Company to a Group","description":"Adds one company id to a group's tracked list.","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"group","in":"path","required":true,"schema":{"type":"string"},"description":"Group name."},{"name":"companyId","in":"path","required":true,"schema":{"type":"string"},"description":"Intellizence company id."}],"responses":{"200":{"description":"`status: 200` on success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"}}}}}},"delete":{"tags":["Company Tracking API (Deprecated)"],"deprecated":true,"summary":"Remove a Single Company from a Group","description":"Removes one company id from a group's tracked list.","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"group","in":"path","required":true,"schema":{"type":"string"},"description":"Group name."},{"name":"companyId","in":"path","required":true,"schema":{"type":"string"},"description":"Intellizence company id."}],"responses":{"200":{"description":"`status: 200` on success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"}}}}}}},"/api/v1/triggers":{"get":{"tags":["Company Tracking API (Deprecated)"],"deprecated":true,"summary":"Get All Triggers","description":"Returns the master list of trigger codes available to your brand (as configured on your subscription).","security":[{"ApiKeyAuth":[]}],"responses":{"200":{"description":"`status: 200` with `triggers`; `status: 404` when the brand is not found.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","example":200},"message":{"type":"string","example":"OK"},"triggers":{"type":"array","items":{"type":"object"}}}}}}}}}},"/api/v1/tracked-triggers/{group}":{"get":{"tags":["Company Tracking API (Deprecated)"],"deprecated":true,"summary":"Get Tracked Triggers in a Group","description":"Returns the trigger codes tracked under the given group.","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"group","in":"path","required":true,"schema":{"type":"string"},"description":"Group name."}],"responses":{"200":{"description":"Tracked triggers for the group.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","example":200},"message":{"type":"string","example":"OK"},"triggers":{"type":"array","items":{"type":"object"}}}}}}}}}},"/api/v1/trigger/{group}":{"post":{"tags":["Company Tracking API (Deprecated)"],"deprecated":true,"summary":"Add Triggers to a Group","description":"Adds trigger codes to a group's tracked list. Body accepts `triggerCodes`, `trigger_codes`, `triggerCode`, or `codes` (array or comma-separated string). `status: 404` when the group does not exist; `status: 202` when a code is unknown; `status: 201` when the plan's max triggers is exceeded.","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"group","in":"path","required":true,"schema":{"type":"string"},"description":"Group name."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"triggerCodes":{"type":"array","items":{"type":"string"},"example":["KW_518","KW_528"]}}},"example":{"triggerCodes":["KW_518","KW_528"]}}}},"responses":{"200":{"description":"`status: 200` with `addedTriggerCodes`.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","example":200},"message":{"type":"string","example":"OK"},"addedTriggerCodes":{"type":"array","items":{"type":"string"}}}}}}}}},"delete":{"tags":["Company Tracking API (Deprecated)"],"deprecated":true,"summary":"Remove Triggers from a Group","description":"Removes trigger codes from a group's tracked list. Body accepts `triggerCodes`, `trigger_codes`, `triggerCode`, or `codes`.","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"group","in":"path","required":true,"schema":{"type":"string"},"description":"Group name."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"triggerCodes":{"type":"array","items":{"type":"string"},"example":["KW_518"]}}},"example":{"triggerCodes":["KW_518"]}}}},"responses":{"200":{"description":"`status: 200` on success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"}}}}}}},"/api/v1/trigger/{group}/{triggerCode}":{"post":{"tags":["Company Tracking API (Deprecated)"],"deprecated":true,"summary":"Add a Single Trigger to a Group","description":"Adds one trigger code to a group's tracked list.","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"group","in":"path","required":true,"schema":{"type":"string"},"description":"Group name."},{"name":"triggerCode","in":"path","required":true,"schema":{"type":"string"},"description":"Intellizence trigger code, e.g. KW_518."}],"responses":{"200":{"description":"`status: 200` on success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"}}}}}},"delete":{"tags":["Company Tracking API (Deprecated)"],"deprecated":true,"summary":"Remove a Single Trigger from a Group","description":"Removes one trigger code from a group's tracked list.","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"group","in":"path","required":true,"schema":{"type":"string"},"description":"Group name."},{"name":"triggerCode","in":"path","required":true,"schema":{"type":"string"},"description":"Intellizence trigger code, e.g. KW_518."}],"responses":{"200":{"description":"`status: 200` on success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"}}}}}}},"/api/v1/recommend-company":{"post":{"tags":["Company Tracking API (Deprecated)"],"deprecated":true,"summary":"Recommend a Company","description":"Submits a company (name and/or domain) to be added to the Intellizence database. If the company is already known, its id is returned; otherwise a recommendation is queued for review.","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"Acme Corp"},"domain":{"type":"string","example":"acme.com"}}},"example":{"name":"Acme Corp","domain":"acme.com"}}}},"responses":{"200":{"description":"`status: 200` with the recommendation record (`status: 201` when neither `name` nor `domain` is sent).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"}}}}}}},"/api/v1/bulk-recommend-companies":{"post":{"tags":["Company Tracking API (Deprecated)"],"deprecated":true,"summary":"Bulk Recommend Companies","description":"Queues multiple company recommendations for review. Returns a `requestId` to poll with POST /api/v1/bulk-recommend-companies-result.","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"companies":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"domain":{"type":"string"}}}}}},"example":{"companies":[{"name":"Acme Corp","domain":"acme.com"},{"name":"Globex","domain":"globex.com"}]}}}},"responses":{"200":{"description":"`status: 0` with `requestId` for the queued batch.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","example":0},"requestId":{"type":"string"}}}}}}}}},"/api/v1/bulk-map-companies":{"post":{"tags":["Company Tracking API (Deprecated)"],"deprecated":true,"summary":"Bulk Map Companies","description":"Submits name/domain mappings to resolve against the Intellizence database. Returns a `requestId` to poll with GET /api/v1/bulk-map-companies-result/{requestId}.","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"mappings":{"type":"array","items":{"type":"object"}}}},"example":{"mappings":[{"name":"Acme Corp","domain":"acme.com"}]}}}},"responses":{"200":{"description":"`status: 0` with `requestId` for the queued batch.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","example":0},"requestId":{"type":"string"}}}}}}}}},"/api/v1/bulk-map-companies-result/{requestId}":{"get":{"tags":["Company Tracking API (Deprecated)"],"deprecated":true,"summary":"Get Bulk Map Companies Result","description":"Polls the result of a bulk-map request.","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"requestId","in":"path","required":true,"schema":{"type":"string"},"description":"requestId returned by POST /api/v1/bulk-map-companies."}],"responses":{"200":{"description":"`status: 0` with `requestId` and processed mapping items.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"}}}}}}},"/api/v1/bulk-recommend-companies-result":{"post":{"tags":["Company Tracking API (Deprecated)"],"deprecated":true,"summary":"Get Bulk Recommend Companies Result","description":"Polls the result of a bulk-recommend request. `requestId` is accepted in the body (`requestId`/`request_id`) or as a query param.","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["requestId"],"properties":{"requestId":{"type":"string"}}},"example":{"requestId":"abc123"}}}},"responses":{"200":{"description":"`status: 0` with processing progress and recommendation ids.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"}}}}}}},"/api/v1/company-recommendation/{recommendationId}":{"get":{"tags":["Company Tracking API (Deprecated)"],"deprecated":true,"summary":"Get Company Recommendation Result","description":"Returns the status/result of a single company recommendation.","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"recommendationId","in":"path","required":true,"schema":{"type":"string"},"description":"Recommendation id."}],"responses":{"200":{"description":"Recommendation record with its review status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"}}}}}}},"/api/v1/bulk-cancel-recommended-companies":{"post":{"tags":["Company Tracking API (Deprecated)"],"deprecated":true,"summary":"Bulk Cancel Recommended Companies","description":"Cancels pending company recommendations. Body accepts `recommendationIds`, `recommendation_ids`, or `ids`.","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"recommendationIds":{"type":"array","items":{"type":"string"}}}},"example":{"recommendationIds":["65f1a2b3c4d5e6f7a8b9c0d1"]}}}},"responses":{"200":{"description":"`status` with cancellation result.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"}}}}}}},"/api/v1/bulk-modify-recommended-companies":{"post":{"tags":["Company Tracking API (Deprecated)"],"deprecated":true,"summary":"Bulk Modify Recommended Companies","description":"Modifies pending company recommendations. Body accepts `modifications` or `companies` — an array of objects with `recommendationId` plus the fields to change (`name`, `domain`).","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"modifications":{"type":"array","items":{"type":"object"}}}},"example":{"modifications":[{"recommendationId":"65f1a2b3c4d5e6f7a8b9c0d1","name":"Acme Corporation","domain":"acmecorp.com"}]}}}},"responses":{"200":{"description":"`status` with modification result.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"}}}}}}},"/api/dataset/mna":{"post":{"tags":["Dataset API"],"summary":"Mergers & Acquisitions (M&A)","description":"This REST API endpoint provides access to both ongoing and historical Mergers & Acquisitions (M&A) and Divestment deal data from the Intellizence Mergers & Acquisitions Dataset. Data access is limited to records within your subscription's entitled date range.\n\nUsers can filter results using the following parameters:\n\n`dateType`, `startDate`, `endDate`, `date`,\n`acquiringCompanyName`, `acquiringCompanyDomain`, `acquiringCompanyIndustry`, `acquiringCompanyLocation`, `acquiringCompanyType`, `acquiringCompanyTicker`,\n`acquiredCompanyName`, `acquiredCompanyDomain`, `acquiredCompanyIndustry`, `acquiredCompanyLocation`, `acquiredCompanyType`, `acquiredCompanyTicker`,\n`sellingCompanyName`, `sellingCompanyDomain`, `sellingCompanyIndustry`, `sellingCompanyLocation`, `sellingCompanyType`, `sellingCompanyTicker`,\n`dealAmount`, `currency`, `mnaStatus`, and `mnaType`.\n\nUsers can limit the number of records returned using the `limit` parameter. All parameters are optional.\nThe API key must be passed in the HTTP header as `x-api-key`.\n\n**Keeping a local copy in sync**: use `dateType: \"ANNOUNCED\"` for the initial historical pull (active records only), then poll with `dateType: \"LAST-MODIFIED\"` for daily updates. `LAST-MODIFIED` also returns records deactivated by our curation team — those carry `status: 0` so you can deactivate or delete them on your side.\n","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MnaRequest"},"examples":{"getDailyUpdatedRecords":{"summary":"Get Daily Updated Records","value":{"dateType":"LAST-MODIFIED","date":"2025-02-24","limit":1}},"getDealsAnnouncedOnASpecificDate":{"summary":"Get Deals Announced on a Specific Date","value":{"dateType":"ANNOUNCED","date":"2025-02-24","limit":1}},"getDealsAnnouncedWithinADateRange":{"summary":"Get Deals Announced Within a Date Range","value":{"dateType":"ANNOUNCED","startDate":"2025-02-01","endDate":"2025-02-28","limit":1}},"searchByAcquiringCompany":{"summary":"Search by Acquiring Company","value":{"acquiringCompanyName":"Blackstone","limit":1}},"searchByAcquiredCompany":{"summary":"Search by Acquired Company","value":{"acquiredCompanyName":"VMware","limit":1}},"searchByIndustry":{"summary":"Search by Industry","value":{"acquiredCompanyIndustry":["technology","financial services"],"limit":1}},"searchByCompanyLocation":{"summary":"Search by Company Location","value":{"acquiredCompanyLocation":"United States of America","limit":1}},"searchByDealStatus":{"summary":"Search by Deal Status","value":{"mnaStatus":"Announced","limit":1}},"searchByDealValue":{"summary":"Search by Deal Value","value":{"dealAmount":">1000000000","currency":"USD","limit":1}},"useMultipleFiltersTogether":{"summary":"Use Multiple Filters Together","value":{"dateType":"ANNOUNCED","startDate":"2025-01-01","endDate":"2025-03-31","acquiredCompanyIndustry":["technology"],"acquiringCompanyType":["Public"],"mnaStatus":"Announced","dealAmount":">500000000","currency":"USD","limit":1}},"dailyDataSync":{"summary":"Daily Data Sync","value":{"dateType":"LAST-MODIFIED","date":"2025-02-24","limit":1}},"cRMOrAccountEnrichment":{"summary":"CRM or Account Enrichment","value":{"acquiringCompanyDomain":"salesforce.com","dateType":"LAST-MODIFIED","startDate":"2025-01-01","endDate":"2025-03-31","limit":1}},"investmentResearch":{"summary":"Investment Research","value":{"dateType":"ANNOUNCED","startDate":"2025-01-01","endDate":"2025-12-31","acquiredCompanyIndustry":["healthcare"],"dealAmount":">1000000000","currency":"USD","limit":1}},"competitiveIntelligence":{"summary":"Competitive Intelligence","value":{"dateType":"ANNOUNCED","startDate":"2025-01-01","endDate":"2025-03-31","acquiredCompanyIndustry":["software"],"acquiredCompanyLocation":"United States of America","limit":1}},"salesAndAccountMonitoring":{"summary":"Sales and Account Monitoring","value":{"dateType":"LAST-MODIFIED","startDate":"2025-01-01","endDate":"2025-03-31","acquiredCompanyIndustry":["software"],"mnaStatus":"Announced","limit":1}}}}}},"responses":{"200":{"description":"Successful response — paginated M&A records.\nAlways check `code` in the body: 200 = success; 4xx/7xx values are business errors returned with HTTP 200 (see the `ErrorResponse` schema for the full code list).\nCredit fields (`openingBalance`, `closingBalance`, `creditsConsumed`) are returned only for Pay-Per-Use billing.\n","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","example":200},"count":{"type":"integer","description":"Number of records in the dataset array."},"dataset":{"type":"array","items":{"$ref":"#/components/schemas/MnaRecord"}},"hasMore":{"type":"boolean","description":"Whether another page exists. Always present when 'limit' was sent."},"nextId":{"type":"string","description":"Cursor for the next page — present only when hasMore is true. Pass it back as 'nextId' (or 'lastRecordId')."},"openingBalance":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credit balance before this request."},"closingBalance":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credit balance after this request."},"creditsConsumed":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credits charged for this request."}}},"example":{"code":200,"count":1,"dataset":[{"id":"67bd5c88f7fd1a188e2b0ea1","announcedDate":"2025-02-24","acquiringCompany":{"name":"Blackstone","id":"IN108449","domain":"blackstone.com","industries":["angels/ venture capital/ private equity","financial services"],"location":"New York City,New York,United States of America","ticker":["BX"],"stockExchange":["NYSE"],"type":"Public"},"acquiredCompany":{"name":"Safe Harbor Marinas","id":"IN036238","domain":"shmarinas.com","industries":["shipping & ports"],"location":"Fontana,California,United States of America","type":"Private"},"sellingCompany":{"name":"Sun Communities","domain":"suncommunities.com","industries":["real estate"],"location":"Southfield,Michigan,United States of America","ticker":["SUI"],"stockExchange":["NYSE"],"type":"Public"},"dealAmount":5650000000,"currency":"USD","typeOfAcquisition":"Acquisition - Total","mnaStatus":"Announced","url":"http://www.businesswire.com/news/home/20250224590051/en/Blackstone-Infrastructure-to-Acquire-Safe-Harbor-Marinas-in-5.65B-Transaction/?","title":"Blackstone Infrastructure to Acquire Safe Harbor Marinas in $5.65B Transaction","lastModified":"2025-02-25"}]}}}}}}},"/api/dataset/mna/asof":{"post":{"tags":["Dataset API"],"summary":"Mergers & Acquisitions (M&A) — Point-in-Time","description":"Returns the full dataset as it existed at `asof` — for every record, the latest revision at or before that timestamp. Intended for bulk consumers keeping a local mirror of the dataset.\n\n- `asof` is required — `YYYY-MM-DD` (treated as end of that day, UTC) or a full ISO datetime `YYYY-MM-DDTHH:mm:ssZ`.\n- Paginate with `limit` + `nextId` — pass the last record's `id` from the previous page.\n- `status` — `1` active, `0` deactivated by the curation team. Apply it locally to deactivate/delete the record.\n- `version` and `availableAt` identify the exact snapshot revision returned.\n- `company` (and the company objects inside records) reflect the **current** company profile, not the as-of state.\n- `minAvailableAt` in the response is the earliest snapshot timestamp — `asof` values before it return no data.","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsOfRequest"},"examples":{"datasetAsOfADate":{"summary":"Dataset as of a date","value":{"asof":"2026-10-15","limit":100}},"datasetAsOfATimestamp":{"summary":"Dataset as of a timestamp","value":{"asof":"2026-10-15T14:30:00Z","limit":100}},"nextPage":{"summary":"Next page","value":{"asof":"2026-10-15T00:00:00Z","limit":100,"nextId":"681bafcc22e1b135a7a6c137"}}}}}},"responses":{"200":{"description":"Successful response — point-in-time snapshot of M&A records.\nAlways check `code` in the body: 200 = success; 4xx/7xx values are business errors (see the `ErrorResponse` schema).\nCredit fields (`openingBalance`, `closingBalance`, `creditsConsumed`) are returned only for Pay-Per-Use billing.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","example":200},"count":{"type":"integer","description":"Number of records in the dataset array."},"dataset":{"type":"array","items":{"$ref":"#/components/schemas/MnaAsOfRecord"}},"hasMore":{"type":"boolean","description":"Whether another page exists. Present when limit was sent."},"nextId":{"type":"string","description":"Cursor for the next page — present only when hasMore is true. Pass it back as nextId (or lastRecordId)."},"minAvailableAt":{"type":"string","format":"date-time","nullable":true,"description":"Earliest snapshot timestamp in the dataset revisions — as-of queries cannot look further back."},"openingBalance":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credit balance before this request."},"closingBalance":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credit balance after this request."},"creditsConsumed":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credits charged for this request."}}},"example":{"code":200,"count":1,"dataset":[{"id":"67bd5c88f7fd1a188e2b0ea1","announcedDate":"2025-02-24","acquiringCompany":{"name":"Blackstone","id":"IN108449","domain":"blackstone.com","industries":["angels/ venture capital/ private equity","financial services"],"location":"New York City,New York,United States of America","ticker":["BX"],"stockExchange":["NYSE"],"type":"Public"},"acquiredCompany":{"name":"Safe Harbor Marinas","id":"IN036238","domain":"shmarinas.com","industries":["shipping & ports"],"location":"Fontana,California,United States of America","type":"Private"},"sellingCompany":{"name":"Sun Communities","domain":"suncommunities.com","industries":["real estate"],"location":"Southfield,Michigan,United States of America","ticker":["SUI"],"stockExchange":["NYSE"],"type":"Public"},"dealAmount":5650000000,"currency":"USD","typeOfAcquisition":"Acquisition - Total","mnaStatus":"Announced","url":"http://www.businesswire.com/news/home/20250224590051/en/Blackstone-Infrastructure-to-Acquire-Safe-Harbor-Marinas-in-5.65B-Transaction/?","title":"Blackstone Infrastructure to Acquire Safe Harbor Marinas in $5.65B Transaction","lastModified":"2025-02-25","status":1,"version":2,"availableAt":"2026-10-14T02:00:00.000Z"}],"hasMore":true,"nextId":"67bd5c88f7fd1a188e2b0ea1","minAvailableAt":"2026-10-14T02:00:00.000Z"}}}}}}},"/api/dataset/business-expansion":{"post":{"tags":["Dataset API"],"summary":"Business Expansion","description":"This REST API endpoint provides access to both ongoing and historical business expansion (opening up of offices, factories, headquarters, etc) and investment data from the Intellizence Business Expansion Dataset. Data access is limited to records within your subscription's entitled date range.\n\nUsers can search data using various parameters — `dateType`, `startDate`, `endDate`, `date`, `companyDomain`, `companyName`, `companyIndustry`, `companyLocation`, `companyType`, `companyTicker`, `expansionType`, `expansionLocation`, `investment`, `currency` and `jobs`.\n\nUsers can limit the number of records returned using the `limit` parameter. All parameters are optional.\nThe API key must be passed in the HTTP header as `x-api-key`.\n\n**Keeping a local copy in sync**: use `dateType: \"ANNOUNCED\"` for the initial historical pull (active records only), then poll with `dateType: \"LAST-MODIFIED\"` for daily updates. `LAST-MODIFIED` also returns records deactivated by our curation team — those carry `status: 0` so you can deactivate or delete them on your side.\n","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessExpansionRequest"},"examples":{"getDailyUpdatedRecords":{"summary":"Get Daily Updated Records","value":{"dateType":"LAST-MODIFIED","date":"2025-05-01","limit":1}},"getExpansionsAnnouncedOnASpecificDate":{"summary":"Get Expansions Announced on a Specific Date","value":{"dateType":"ANNOUNCED","date":"2025-05-01","limit":1}},"getExpansionsWithinADateRange":{"summary":"Get Expansions Within a Date Range","value":{"dateType":"ANNOUNCED","startDate":"2025-05-01","endDate":"2025-05-31","limit":1}},"searchByCompanyDomain":{"summary":"Search by Company Domain","value":{"companyDomain":"kimberly-clark.com","limit":1}},"searchByCompanyIndustry":{"summary":"Search by Company Industry","value":{"companyIndustry":["manufacturing","technology"],"limit":1}},"searchByExpansionType":{"summary":"Search by Expansion Type","value":{"expansionType":["Factory/Plant","Fulfillment/Distribution Centre/Warehouse"],"limit":1}},"searchByExpansionLocation":{"summary":"Search by Expansion Location","value":{"expansionLocation":"United States of America","limit":1}},"searchByInvestmentAmount":{"summary":"Search by Investment Amount","value":{"investment":">1000000000","currency":"USD","limit":1}},"searchByJobsCreated":{"summary":"Search by Jobs Created","value":{"jobs":">500","limit":1}},"useMultipleFiltersTogether":{"summary":"Use Multiple Filters Together","value":{"dateType":"ANNOUNCED","startDate":"2025-01-01","endDate":"2025-05-31","companyIndustry":["manufacturing"],"companyType":["Public"],"expansionType":["Factory/Plant","Fulfillment/Distribution Centre/Warehouse"],"expansionLocation":"United States of America","investment":">500000000","currency":"USD","jobs":">250","limit":1}},"dailyDataSync":{"summary":"Daily Data Sync","value":{"dateType":"LAST-MODIFIED","date":"2025-05-01","limit":1}},"cRMOrAccountEnrichment":{"summary":"CRM or Account Enrichment","value":{"companyDomain":"kimberly-clark.com","dateType":"LAST-MODIFIED","startDate":"2025-01-01","endDate":"2025-05-31","limit":1}},"investmentResearch":{"summary":"Investment Research","value":{"dateType":"ANNOUNCED","startDate":"2025-01-01","endDate":"2025-12-31","companyIndustry":["manufacturing"],"investment":">1000000000","currency":"USD","limit":1}},"economicDevelopmentAndLocationMonitoring":{"summary":"Economic Development and Location Monitoring","value":{"dateType":"ANNOUNCED","startDate":"2025-01-01","endDate":"2025-12-31","expansionLocation":"United States of America","jobs":">250","limit":1}},"salesAndProspecting":{"summary":"Sales and Prospecting","value":{"dateType":"LAST-MODIFIED","startDate":"2025-01-01","endDate":"2025-05-31","companyIndustry":["technology","manufacturing"],"expansionType":["Branch/Office","Factory/Plant","Fulfillment/Distribution Centre/Warehouse"],"jobs":">100","limit":1}}}}}},"responses":{"200":{"description":"Successful response — paginated business expansion records.\nAlways check `code` in the body: 200 = success; 4xx/7xx values are business errors returned with HTTP 200 (see the `ErrorResponse` schema for the full code list).\nCredit fields (`openingBalance`, `closingBalance`, `creditsConsumed`) are returned only for Pay-Per-Use billing.\n","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","example":200},"count":{"type":"integer","description":"Number of records in the dataset array."},"dataset":{"type":"array","items":{"$ref":"#/components/schemas/BusinessExpansionRecord"}},"hasMore":{"type":"boolean","description":"Whether another page exists. Always present when 'limit' was sent."},"nextId":{"type":"string","description":"Cursor for the next page — present only when hasMore is true. Pass it back as 'nextId' (or 'lastRecordId')."},"openingBalance":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credit balance before this request."},"closingBalance":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credit balance after this request."},"creditsConsumed":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credits charged for this request."}}},"example":{"code":200,"count":2,"dataset":[{"id":"681bafe322e1b135a7a6c138","announcedDate":"2025-05-01","company":{"name":"Kimberly-Clark","domain":"kimberly-clark.com","industries":["manufacturing"],"location":"Irving,Texas,United States of America","ticker":["KMB"],"stockExchange":["NYSE"],"type":"Public"},"expansionType":["Fulfillment/Distribution Centre/Warehouse"],"location":{"country":"United States of America","state":"South Carolina"},"url":"https://www.newsmax.com/newsfront/kimberly-clark-u-s-manufacturing/2025/05/01/id/1209174","title":"Kimberly-Clark to Invest $2B to Bulk up US Manufacturing","lastModified":"2025-05-07"},{"id":"681bafcc22e1b135a7a6c137","announcedDate":"2025-05-01","company":{"name":"Kimberly-Clark","domain":"kimberly-clark.com","industries":["manufacturing"],"location":"Irving,Texas,United States of America","ticker":["KMB"],"stockExchange":["NYSE"],"type":"Public"},"investment":2000000000,"currency":"USD","expansionType":["Factory/Plant"],"jobs":900,"location":{"country":"United States of America","state":"Ohio","city":"Warren"},"url":"https://www.newsmax.com/newsfront/kimberly-clark-u-s-manufacturing/2025/05/01/id/1209174","title":"Kimberly-Clark to Invest $2B to Bulk up US Manufacturing","lastModified":"2025-05-07"}]}}}}}}},"/api/dataset/business-expansion/asof":{"post":{"tags":["Dataset API"],"summary":"Business Expansion — Point-in-Time","description":"Returns the full dataset as it existed at `asof` — for every record, the latest revision at or before that timestamp. Intended for bulk consumers keeping a local mirror of the dataset.\n\n- `asof` is required — `YYYY-MM-DD` (treated as end of that day, UTC) or a full ISO datetime `YYYY-MM-DDTHH:mm:ssZ`.\n- Paginate with `limit` + `nextId` — pass the last record's `id` from the previous page.\n- `status` — `1` active, `0` deactivated by the curation team. Apply it locally to deactivate/delete the record.\n- `version` and `availableAt` identify the exact snapshot revision returned.\n- `company` (and the company objects inside records) reflect the **current** company profile, not the as-of state.\n- `minAvailableAt` in the response is the earliest snapshot timestamp — `asof` values before it return no data.","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsOfRequest"},"examples":{"datasetAsOfADate":{"summary":"Dataset as of a date","value":{"asof":"2026-10-15","limit":100}},"datasetAsOfATimestamp":{"summary":"Dataset as of a timestamp","value":{"asof":"2026-10-15T14:30:00Z","limit":100}},"nextPage":{"summary":"Next page","value":{"asof":"2026-10-15T00:00:00Z","limit":100,"nextId":"681bafcc22e1b135a7a6c137"}}}}}},"responses":{"200":{"description":"Successful response — point-in-time snapshot of business expansion records.\nAlways check `code` in the body: 200 = success; 4xx/7xx values are business errors (see the `ErrorResponse` schema).\nCredit fields (`openingBalance`, `closingBalance`, `creditsConsumed`) are returned only for Pay-Per-Use billing.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","example":200},"count":{"type":"integer","description":"Number of records in the dataset array."},"dataset":{"type":"array","items":{"$ref":"#/components/schemas/BusinessExpansionAsOfRecord"}},"hasMore":{"type":"boolean","description":"Whether another page exists. Present when limit was sent."},"nextId":{"type":"string","description":"Cursor for the next page — present only when hasMore is true. Pass it back as nextId (or lastRecordId)."},"minAvailableAt":{"type":"string","format":"date-time","nullable":true,"description":"Earliest snapshot timestamp in the dataset revisions — as-of queries cannot look further back."},"openingBalance":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credit balance before this request."},"closingBalance":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credit balance after this request."},"creditsConsumed":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credits charged for this request."}}},"example":{"code":200,"count":1,"dataset":[{"id":"681bafcc22e1b135a7a6c137","announcedDate":"2025-05-01","company":{"name":"Kimberly-Clark","domain":"kimberly-clark.com","industries":["manufacturing"],"location":"Irving,Texas,United States of America","ticker":["KMB"],"stockExchange":["NYSE"],"type":"Public"},"investment":2000000000,"currency":"USD","expansionType":["Factory/Plant"],"jobs":900,"location":{"country":"United States of America","state":"Ohio","city":"Warren"},"url":"https://www.newsmax.com/newsfront/kimberly-clark-u-s-manufacturing/2025/05/01/id/1209174","title":"Kimberly-Clark to Invest $2B to Bulk up US Manufacturing","lastModified":"2025-05-07","status":1,"version":1,"availableAt":"2026-10-14T02:00:00.000Z"}],"hasMore":true,"nextId":"681bafcc22e1b135a7a6c137","minAvailableAt":"2026-10-14T02:00:00.000Z"}}}}}}},"/api/dataset/data-breach":{"post":{"tags":["Dataset API"],"summary":"Data & Security Breaches","description":"This REST API endpoint provides access to both ongoing and historical data and security breaches data from the Intellizence Data and Security Breaches Dataset. Data access is limited to records within your subscription's entitled date range.\n\nUsers can search data using various parameters — `dateType`, `startDate`, `endDate`, `date`, `companyDomain`, `companyName`, `companyIndustry`, `companyLocation`, `companyType`, `companyTicker`, `incidentType`, and `peopleImpacted`.\n\nUsers can limit the number of records returned using the `limit` parameter. All parameters are optional.\nThe API key must be passed in the HTTP header as `x-api-key`.\n\n**Keeping a local copy in sync**: use `dateType: \"ANNOUNCED\"` for the initial historical pull (active records only), then poll with `dateType: \"LAST-MODIFIED\"` for daily updates. `LAST-MODIFIED` also returns records deactivated by our curation team — those carry `status: 0` so you can deactivate or delete them on your side.\n","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataBreachRequest"},"examples":{"getDailyUpdatedRecords":{"summary":"Get Daily Updated Records","value":{"dateType":"LAST-MODIFIED","date":"2025-05-05","limit":1}},"getIncidentsAnnouncedOnASpecificDate":{"summary":"Get Incidents Announced on a Specific Date","value":{"dateType":"ANNOUNCED","date":"2025-05-05","limit":1}},"getIncidentsWithinADateRange":{"summary":"Get Incidents Within a Date Range","value":{"dateType":"ANNOUNCED","startDate":"2025-05-01","endDate":"2025-05-31","limit":1}},"searchByCompanyDomain":{"summary":"Search by Company Domain","value":{"companyDomain":"ameriprise.com","limit":1}},"searchByCompanyIndustry":{"summary":"Search by Company Industry","value":{"companyIndustry":["financial services","healthcare"],"limit":1}},"searchByCompanyLocation":{"summary":"Search by Company Location","value":{"companyLocation":"Minneapolis,Minnesota,United States of America","limit":1}},"searchByIncidentType":{"summary":"Search by Incident Type","value":{"incidentType":["Data Breach/Theft/Leak","Ransomware"],"limit":1}},"searchByPeopleImpacted":{"summary":"Search by People Impacted","value":{"peopleImpacted":">100000","limit":1}},"searchByPublicCompanyTicker":{"summary":"Search by Public Company Ticker","value":{"companyTicker":"AMP","limit":1}},"useMultipleFiltersTogether":{"summary":"Use Multiple Filters Together","value":{"dateType":"ANNOUNCED","startDate":"2025-01-01","endDate":"2025-05-31","companyIndustry":["financial services","healthcare"],"companyType":["Public"],"incidentType":["Data Breach/Theft/Leak","Ransomware"],"peopleImpacted":">100000","companyLocation":"United States of America","limit":1}},"dailyDataSync":{"summary":"Daily Data Sync","value":{"dateType":"LAST-MODIFIED","date":"2025-05-05","limit":1}},"vendorRiskAndThirdPartyMonitoring":{"summary":"Vendor Risk and Third-Party Monitoring","value":{"companyDomain":"ameriprise.com","dateType":"LAST-MODIFIED","startDate":"2025-01-01","endDate":"2025-05-31","limit":1}},"sectorCyberRiskAnalysis":{"summary":"Sector Cyber Risk Analysis","value":{"dateType":"ANNOUNCED","startDate":"2025-01-01","endDate":"2025-05-31","companyIndustry":["financial services","healthcare"],"incidentType":["Data Breach/Theft/Leak","Ransomware"],"limit":1}},"largeBreachMonitoring":{"summary":"Large Breach Monitoring","value":{"dateType":"ANNOUNCED","startDate":"2025-01-01","endDate":"2025-12-31","peopleImpacted":">1000000","incidentType":["Data Breach/Theft/Leak","Security Breach"],"limit":1}},"salesAndAccountMonitoring":{"summary":"Sales and Account Monitoring","value":{"dateType":"LAST-MODIFIED","startDate":"2025-01-01","endDate":"2025-05-31","companyIndustry":["financial services","healthcare","technology"],"incidentType":["Data Breach/Theft/Leak","Ransomware","Security Breach"],"limit":1}}}}}},"responses":{"200":{"description":"Successful response — paginated data & security breach records.\nAlways check `code` in the body: 200 = success; 4xx/7xx values are business errors returned with HTTP 200 (see the `ErrorResponse` schema for the full code list).\nCredit fields (`openingBalance`, `closingBalance`, `creditsConsumed`) are returned only for Pay-Per-Use billing.\n","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","example":200},"count":{"type":"integer","description":"Number of records in the dataset array."},"dataset":{"type":"array","items":{"$ref":"#/components/schemas/DataBreachRecord"}},"hasMore":{"type":"boolean","description":"Whether another page exists. Always present when 'limit' was sent."},"nextId":{"type":"string","description":"Cursor for the next page — present only when hasMore is true. Pass it back as 'nextId' (or 'lastRecordId')."},"openingBalance":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credit balance before this request."},"closingBalance":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credit balance after this request."},"creditsConsumed":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credits charged for this request."}}},"example":{"code":200,"count":1,"dataset":[{"id":"68276f415e482b5fac9f511a","announcedDate":"2025-05-05","company":{"name":"Ameriprise Financial","domain":"ameriprise.com","industries":["financial services"],"location":"Minneapolis,Minnesota,United States of America","ticker":["AMP"],"stockExchange":["NYSE"],"type":"Public"},"incidentType":["Data Breach/Theft/Leak"],"peopleImpacted":1,"incidentDate":"2025-04-29","sourceType":"Regulatory Filings","url":"https://www.maine.gov/agviewer/content/ag/985235c7-cb95-4be2-8792-a1252b4f8318/b0808b89-a298-40ae-85a4-07e8e192d654.html","title":"Maine Data Breach Notifications","lastModified":"2025-05-16"}]}}}}}}},"/api/dataset/data-breach/asof":{"post":{"tags":["Dataset API"],"summary":"Data & Security Breaches — Point-in-Time","description":"Returns the full dataset as it existed at `asof` — for every record, the latest revision at or before that timestamp. Intended for bulk consumers keeping a local mirror of the dataset.\n\n- `asof` is required — `YYYY-MM-DD` (treated as end of that day, UTC) or a full ISO datetime `YYYY-MM-DDTHH:mm:ssZ`.\n- Paginate with `limit` + `nextId` — pass the last record's `id` from the previous page.\n- `status` — `1` active, `0` deactivated by the curation team. Apply it locally to deactivate/delete the record.\n- `version` and `availableAt` identify the exact snapshot revision returned.\n- `company` (and the company objects inside records) reflect the **current** company profile, not the as-of state.\n- `minAvailableAt` in the response is the earliest snapshot timestamp — `asof` values before it return no data.","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsOfRequest"},"examples":{"datasetAsOfADate":{"summary":"Dataset as of a date","value":{"asof":"2026-10-15","limit":100}},"datasetAsOfATimestamp":{"summary":"Dataset as of a timestamp","value":{"asof":"2026-10-15T14:30:00Z","limit":100}},"nextPage":{"summary":"Next page","value":{"asof":"2026-10-15T00:00:00Z","limit":100,"nextId":"681bafcc22e1b135a7a6c137"}}}}}},"responses":{"200":{"description":"Successful response — point-in-time snapshot of data breach records.\nAlways check `code` in the body: 200 = success; 4xx/7xx values are business errors (see the `ErrorResponse` schema).\nCredit fields (`openingBalance`, `closingBalance`, `creditsConsumed`) are returned only for Pay-Per-Use billing.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","example":200},"count":{"type":"integer","description":"Number of records in the dataset array."},"dataset":{"type":"array","items":{"$ref":"#/components/schemas/DataBreachAsOfRecord"}},"hasMore":{"type":"boolean","description":"Whether another page exists. Present when limit was sent."},"nextId":{"type":"string","description":"Cursor for the next page — present only when hasMore is true. Pass it back as nextId (or lastRecordId)."},"minAvailableAt":{"type":"string","format":"date-time","nullable":true,"description":"Earliest snapshot timestamp in the dataset revisions — as-of queries cannot look further back."},"openingBalance":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credit balance before this request."},"closingBalance":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credit balance after this request."},"creditsConsumed":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credits charged for this request."}}},"example":{"code":200,"count":1,"dataset":[{"id":"68276f415e482b5fac9f511a","announcedDate":"2025-05-05","company":{"name":"Ameriprise Financial","domain":"ameriprise.com","industries":["financial services"],"location":"Minneapolis,Minnesota,United States of America","ticker":["AMP"],"stockExchange":["NYSE"],"type":"Public"},"incidentType":["Data Breach/Theft/Leak"],"peopleImpacted":1,"incidentDate":"2025-04-29","sourceType":"Regulatory Filings","url":"https://www.maine.gov/agviewer/content/ag/985235c7-cb95-4be2-8792-a1252b4f8318/b0808b89-a298-40ae-85a4-07e8e192d654.html","title":"Maine Data Breach Notifications","lastModified":"2025-05-16","status":1,"version":1,"availableAt":"2026-10-14T02:00:00.000Z"}],"hasMore":true,"nextId":"68276f415e482b5fac9f511a","minAvailableAt":"2026-10-14T02:00:00.000Z"}}}}}}},"/api/dataset/executive-change":{"post":{"tags":["Dataset API"],"summary":"C-Suite Changes","description":"This REST API endpoint provides access to both ongoing and historical C-Level changes (appointment, promotion, retirement, resignation & termination) data from the Intellizence C-Suite Changes Dataset. Data access is limited to records within your subscription's entitled date range.\n\nUsers can search data using various parameters — `dateType`, `startDate`, `endDate`, `date`, `companyDomain`, `companyName`, `companyIndustry`, `companyLocation`, `companyType`, `companyTicker`, `executiveName`, `executiveTitle`, `executiveTitleCategory`, and `reason`.\n\nUsers can limit the number of records returned using the `limit` parameter. All parameters are optional.\nThe API key must be passed in the HTTP header as `x-api-key`.\n\n**Keeping a local copy in sync**: use `dateType: \"ANNOUNCED\"` for the initial historical pull (active records only), then poll with `dateType: \"LAST-MODIFIED\"` for daily updates. `LAST-MODIFIED` also returns records deactivated by our curation team — those carry `status: 0` so you can deactivate or delete them on your side.\n","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutiveChangeRequest"},"examples":{"getDailyUpdatedRecords":{"summary":"Get Daily Updated Records","value":{"dateType":"LAST-MODIFIED","date":"2025-05-03","limit":1}},"getCSuiteChangesAnnouncedOnASpecificDate":{"summary":"Get C-Suite Changes Announced on a Specific Date","value":{"dateType":"ANNOUNCED","date":"2025-05-03","limit":1}},"getCSuiteChangesWithinADateRange":{"summary":"Get C-Suite Changes Within a Date Range","value":{"dateType":"ANNOUNCED","startDate":"2025-05-01","endDate":"2025-05-31","limit":1}},"searchByCompanyDomain":{"summary":"Search by Company Domain","value":{"companyDomain":"berkshirehathaway.com","limit":1}},"searchByExecutiveTitleCategory":{"summary":"Search by Executive Title Category","value":{"executiveTitleCategory":["Chief Executive Officer ( CEO)/President/Managing Director","Chief Financial Officer ( CFO) / Head of Finance"],"limit":1}},"searchByExecutiveTitle":{"summary":"Search by Executive Title","value":{"executiveTitle":"Chief Executive Officer","limit":1}},"searchByExecutiveName":{"summary":"Search by Executive Name","value":{"executiveName":"Greg Abel","limit":1}},"searchByReason":{"summary":"Search by Reason","value":{"reason":["New Appointment","Promoted/Role Change"],"limit":1}},"searchByCompanyIndustry":{"summary":"Search by Company Industry","value":{"companyIndustry":["technology","financial services"],"limit":1}},"useMultipleFiltersTogether":{"summary":"Use Multiple Filters Together","value":{"dateType":"ANNOUNCED","startDate":"2025-01-01","endDate":"2025-05-31","companyIndustry":["technology"],"companyType":["Public"],"executiveTitleCategory":["Chief Executive Officer ( CEO)/President/Managing Director","Chief Financial Officer ( CFO) / Head of Finance"],"reason":["New Appointment","Promoted/Role Change"],"companyLocation":"United States of America","limit":1}},"dailyDataSync":{"summary":"Daily Data Sync","value":{"dateType":"LAST-MODIFIED","date":"2025-05-03","limit":1}},"cRMOrAccountEnrichment":{"summary":"CRM or Account Enrichment","value":{"companyDomain":"berkshirehathaway.com","dateType":"LAST-MODIFIED","startDate":"2025-01-01","endDate":"2025-05-31","limit":1}},"salesAndProspecting":{"summary":"Sales and Prospecting","value":{"dateType":"LAST-MODIFIED","startDate":"2025-01-01","endDate":"2025-05-31","companyIndustry":["technology"],"executiveTitleCategory":["Chief Executive Officer ( CEO)/President/Managing Director","Chief Revenue Officer ( CRO) / Head of Sales","Chief Marketing Officer ( CMO)"],"reason":["New Appointment","Promoted/Role Change"],"limit":1}},"executiveSearchAndTalentIntelligence":{"summary":"Executive Search and Talent Intelligence","value":{"dateType":"ANNOUNCED","startDate":"2025-01-01","endDate":"2025-12-31","companyIndustry":["healthcare","technology"],"executiveTitleCategory":["Chief Executive Officer ( CEO)/President/Managing Director","Chief Financial Officer ( CFO) / Head of Finance","Chief Operating Officer ( COO)"],"companyLocation":"United States of America","limit":1}},"riskAndCustomerSuccessMonitoring":{"summary":"Risk and Customer Success Monitoring","value":{"dateType":"LAST-MODIFIED","startDate":"2025-01-01","endDate":"2025-05-31","reason":["Resigned","Retired","Terminated"],"executiveTitleCategory":["Chief Executive Officer ( CEO)/President/Managing Director","Chief Financial Officer ( CFO) / Head of Finance","Chief Operating Officer ( COO)"],"limit":1}}}}}},"responses":{"200":{"description":"Successful response — paginated C-Suite change records.\nAlways check `code` in the body: 200 = success; 4xx/7xx values are business errors returned with HTTP 200 (see the `ErrorResponse` schema for the full code list).\nCredit fields (`openingBalance`, `closingBalance`, `creditsConsumed`) are returned only for Pay-Per-Use billing.\n","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","example":200},"count":{"type":"integer","description":"Number of records in the dataset array."},"dataset":{"type":"array","items":{"$ref":"#/components/schemas/ExecutiveChangeRecord"}},"hasMore":{"type":"boolean","description":"Whether another page exists. Always present when 'limit' was sent."},"nextId":{"type":"string","description":"Cursor for the next page — present only when hasMore is true. Pass it back as 'nextId' (or 'lastRecordId')."},"openingBalance":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credit balance before this request."},"closingBalance":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credit balance after this request."},"creditsConsumed":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credits charged for this request."}}},"example":{"code":200,"count":2,"dataset":[{"id":"68181c31798794a88a9e8122","announcedDate":"2025-05-03","company":{"name":"Berkshire Hathaway","domain":"berkshirehathaway.com","industries":["insurance","conglomerate"],"location":"Omaha,Nebraska,United States of America","ticker":["BRK.A"],"stockExchange":["NYSE"],"type":"Public"},"executiveName":"Greg Abel","executiveTitle":"Chief Executive Officer","executiveTitleCategory":["Chief Executive Officer (CEO)/President/Managing Director"],"reason":"Promoted/Role Change","effectiveDate":"2026-01-01","url":"https://www.reuters.com/markets/wealth/berkshire-shareholders-head-buffetts-60th-annual-meeting-economy-top-mind-2025-05-03/","title":"Buffett to step down as Berkshire CEO after 60 years at helm, passes baton to Abel","lastModified":"2025-05-05"},{"id":"68181c2c798794a88a9e811e","announcedDate":"2025-05-03","company":{"name":"Berkshire Hathaway","domain":"berkshirehathaway.com","industries":["insurance","conglomerate"],"location":"Omaha,Nebraska,United States of America","ticker":["BRK.A"],"stockExchange":["NYSE"],"type":"Public"},"executiveName":"Warren Buffett","executiveTitle":"Chief Executive Officer","executiveTitleCategory":["Chief Executive Officer (CEO)/President/Managing Director"],"reason":"Resigned","url":"https://www.reuters.com/markets/wealth/berkshire-shareholders-head-buffetts-60th-annual-meeting-economy-top-mind-2025-05-03/","title":"Buffett to step down as Berkshire CEO after 60 years at helm, passes baton to Abel","lastModified":"2025-05-05"}]}}}}}}},"/api/dataset/executive-change/asof":{"post":{"tags":["Dataset API"],"summary":"C-Suite Changes — Point-in-Time","description":"Returns the full dataset as it existed at `asof` — for every record, the latest revision at or before that timestamp. Intended for bulk consumers keeping a local mirror of the dataset.\n\n- `asof` is required — `YYYY-MM-DD` (treated as end of that day, UTC) or a full ISO datetime `YYYY-MM-DDTHH:mm:ssZ`.\n- Paginate with `limit` + `nextId` — pass the last record's `id` from the previous page.\n- `status` — `1` active, `0` deactivated by the curation team. Apply it locally to deactivate/delete the record.\n- `version` and `availableAt` identify the exact snapshot revision returned.\n- `company` (and the company objects inside records) reflect the **current** company profile, not the as-of state.\n- `minAvailableAt` in the response is the earliest snapshot timestamp — `asof` values before it return no data.","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsOfRequest"},"examples":{"datasetAsOfADate":{"summary":"Dataset as of a date","value":{"asof":"2026-10-15","limit":100}},"datasetAsOfATimestamp":{"summary":"Dataset as of a timestamp","value":{"asof":"2026-10-15T14:30:00Z","limit":100}},"nextPage":{"summary":"Next page","value":{"asof":"2026-10-15T00:00:00Z","limit":100,"nextId":"681bafcc22e1b135a7a6c137"}}}}}},"responses":{"200":{"description":"Successful response — point-in-time snapshot of executive change records.\nAlways check `code` in the body: 200 = success; 4xx/7xx values are business errors (see the `ErrorResponse` schema).\nCredit fields (`openingBalance`, `closingBalance`, `creditsConsumed`) are returned only for Pay-Per-Use billing.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","example":200},"count":{"type":"integer","description":"Number of records in the dataset array."},"dataset":{"type":"array","items":{"$ref":"#/components/schemas/ExecutiveChangeAsOfRecord"}},"hasMore":{"type":"boolean","description":"Whether another page exists. Present when limit was sent."},"nextId":{"type":"string","description":"Cursor for the next page — present only when hasMore is true. Pass it back as nextId (or lastRecordId)."},"minAvailableAt":{"type":"string","format":"date-time","nullable":true,"description":"Earliest snapshot timestamp in the dataset revisions — as-of queries cannot look further back."},"openingBalance":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credit balance before this request."},"closingBalance":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credit balance after this request."},"creditsConsumed":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credits charged for this request."}}},"example":{"code":200,"count":1,"dataset":[{"id":"68181c31798794a88a9e8122","announcedDate":"2025-05-03","company":{"name":"Berkshire Hathaway","domain":"berkshirehathaway.com","industries":["insurance","conglomerate"],"location":"Omaha,Nebraska,United States of America","ticker":["BRK.A"],"stockExchange":["NYSE"],"type":"Public"},"executiveName":"Greg Abel","executiveTitle":"Chief Executive Officer","executiveTitleCategory":["Chief Executive Officer ( CEO)/President/Managing Director"],"reason":"Promoted/Role Change","effectiveDate":"2026-01-01","url":"https://www.reuters.com/markets/wealth/berkshire-shareholders-head-buffetts-60th-annual-meeting-economy-top-mind-2025-05-03/","title":"Buffett to step down as Berkshire CEO after 60 years at helm, passes baton to Abel","lastModified":"2025-05-05","status":1,"version":1,"availableAt":"2026-10-14T02:00:00.000Z"}],"hasMore":true,"nextId":"68181c31798794a88a9e8122","minAvailableAt":"2026-10-14T02:00:00.000Z"}}}}}}},"/api/dataset/fundraising":{"post":{"tags":["Dataset API"],"summary":"Startup Funding & Venture Capital (VC) Deals","description":"This REST API endpoint provides access to both ongoing and historical startup funding and Venture Capital (VC) deals from the Intellizence Startup Funding Dataset. Data access is limited to records within your subscription's entitled date range.\n\nUsers can search data using the following parameters:\n\n`dateType`, `startDate`, `endDate`, `date`, `companyDomain`, `companyName`, `companyIndustry`, `companyLocation`, `companyType`, `companyTicker`, `fundingRound`, `dealAmount`, `valuation`, `investor`, and `currency`.\n\nUsers can limit the number of records returned using the `limit` parameter. All parameters are optional.\nThe API key must be passed in the HTTP header as `x-api-key`.\n\n**Keeping a local copy in sync**: use `dateType: \"ANNOUNCED\"` for the initial historical pull (active records only), then poll with `dateType: \"LAST-MODIFIED\"` for daily updates. `LAST-MODIFIED` also returns records deactivated by our curation team — those carry `status: 0` so you can deactivate or delete them on your side.\n\nNote: Startup funding data is generally available for VC-funded private companies only. It is not available for public companies, non-VC-funded private companies, government entities, hospitals, universities, or other non-commercial organizations.\n","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundraisingRequest"},"examples":{"getDailyUpdatedRecords":{"summary":"Get Daily Updated Records","value":{"dateType":"LAST-MODIFIED","date":"2025-03-03","limit":1}},"getFundingDealsAnnouncedOnASpecificDate":{"summary":"Get Funding Deals Announced on a Specific Date","value":{"dateType":"ANNOUNCED","date":"2025-03-03","limit":1}},"getFundingDealsWithinADateRange":{"summary":"Get Funding Deals Within a Date Range","value":{"dateType":"ANNOUNCED","startDate":"2025-03-01","endDate":"2025-03-31","limit":1}},"searchByCompanyDomain":{"summary":"Search by Company Domain","value":{"companyDomain":"anthropic.com","limit":1}},"searchByInvestor":{"summary":"Search by Investor","value":{"investor":"Lightspeed Venture Partners","limit":1}},"searchByCompanyIndustry":{"summary":"Search by Company Industry","value":{"companyIndustry":["technology","healthcare"],"limit":1}},"searchByCompanyLocation":{"summary":"Search by Company Location","value":{"companyLocation":"San Francisco,California,United States of America","limit":1}},"searchByFundingRound":{"summary":"Search by Funding Round","value":{"fundingRound":["Series A","Series B"],"limit":1}},"searchByFundingAmount":{"summary":"Search by Funding Amount","value":{"dealAmount":">100000000","currency":"USD","limit":1}},"useMultipleFiltersTogether":{"summary":"Use Multiple Filters Together","value":{"dateType":"ANNOUNCED","startDate":"2025-01-01","endDate":"2025-03-31","companyIndustry":["technology"],"companyType":["Private"],"fundingRound":["Series B","Series C"],"dealAmount":">50000000","currency":"USD","limit":1}},"dailyDataSync":{"summary":"Daily Data Sync","value":{"dateType":"LAST-MODIFIED","date":"2025-03-03","limit":1}},"cRMOrAccountEnrichment":{"summary":"CRM or Account Enrichment","value":{"companyDomain":"anthropic.com","dateType":"LAST-MODIFIED","startDate":"2025-01-01","endDate":"2025-03-31","limit":1}},"investmentResearch":{"summary":"Investment Research","value":{"dateType":"ANNOUNCED","startDate":"2025-01-01","endDate":"2025-12-31","companyIndustry":["healthcare"],"dealAmount":">100000000","currency":"USD","limit":1}},"investorTracking":{"summary":"Investor Tracking","value":{"investor":"Lightspeed Venture Partners","dateType":"ANNOUNCED","startDate":"2025-01-01","endDate":"2025-12-31","limit":1}},"salesAndProspecting":{"summary":"Sales and Prospecting","value":{"dateType":"LAST-MODIFIED","startDate":"2025-01-01","endDate":"2025-03-31","companyIndustry":["technology"],"fundingRound":["Series A","Series B","Series C"],"dealAmount":">10000000","currency":"USD","limit":1}}}}}},"responses":{"200":{"description":"Successful response — paginated startup funding records.\nAlways check `code` in the body: 200 = success; 4xx/7xx values are business errors returned with HTTP 200 (see the `ErrorResponse` schema for the full code list).\nCredit fields (`openingBalance`, `closingBalance`, `creditsConsumed`) are returned only for Pay-Per-Use billing.\n","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","example":200},"count":{"type":"integer","description":"Number of records in the dataset array."},"dataset":{"type":"array","items":{"$ref":"#/components/schemas/FundraisingRecord"}},"hasMore":{"type":"boolean","description":"Whether another page exists. Always present when 'limit' was sent."},"nextId":{"type":"string","description":"Cursor for the next page — present only when hasMore is true. Pass it back as 'nextId' (or 'lastRecordId')."},"openingBalance":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credit balance before this request."},"closingBalance":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credit balance after this request."},"creditsConsumed":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credits charged for this request."}}},"example":{"code":200,"count":1,"dataset":[{"id":"67c858abf7fd1a188e2b1ab3","announcedDate":"2025-03-03","company":{"name":"Anthropic","domain":"anthropic.com","industries":["technology"],"location":"San Francisco,California,United States of America","ticker":[],"type":"Private"},"dealAmount":3500000000,"currency":"USD","fundingRound":"Series E","investors":"Lightspeed Venture Partners, Salesforce Ventures, Cisco Investments, Fidelity Management & Research Co., General Catalyst, D1 Capital Partners, Jane Street","leadInvestors":"Lightspeed Venture Partners","valuation":61500000000,"url":"https://www.investopedia.com/ai-startup-anthropic-valued-at-usd61-5b-after-latest-funding-round-11689703","title":"AI Startup Anthropic Valued at $61.5B After Latest Funding Round","lastModified":"2025-03-06"}]}}}}}}},"/api/dataset/fundraising/asof":{"post":{"tags":["Dataset API"],"summary":"Fundraising — Point-in-Time","description":"Returns the full dataset as it existed at `asof` — for every record, the latest revision at or before that timestamp. Intended for bulk consumers keeping a local mirror of the dataset.\n\n- `asof` is required — `YYYY-MM-DD` (treated as end of that day, UTC) or a full ISO datetime `YYYY-MM-DDTHH:mm:ssZ`.\n- Paginate with `limit` + `nextId` — pass the last record's `id` from the previous page.\n- `status` — `1` active, `0` deactivated by the curation team. Apply it locally to deactivate/delete the record.\n- `version` and `availableAt` identify the exact snapshot revision returned.\n- `company` (and the company objects inside records) reflect the **current** company profile, not the as-of state.\n- `minAvailableAt` in the response is the earliest snapshot timestamp — `asof` values before it return no data.","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsOfRequest"},"examples":{"datasetAsOfADate":{"summary":"Dataset as of a date","value":{"asof":"2026-10-15","limit":100}},"datasetAsOfATimestamp":{"summary":"Dataset as of a timestamp","value":{"asof":"2026-10-15T14:30:00Z","limit":100}},"nextPage":{"summary":"Next page","value":{"asof":"2026-10-15T00:00:00Z","limit":100,"nextId":"681bafcc22e1b135a7a6c137"}}}}}},"responses":{"200":{"description":"Successful response — point-in-time snapshot of fundraising records.\nAlways check `code` in the body: 200 = success; 4xx/7xx values are business errors (see the `ErrorResponse` schema).\nCredit fields (`openingBalance`, `closingBalance`, `creditsConsumed`) are returned only for Pay-Per-Use billing.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","example":200},"count":{"type":"integer","description":"Number of records in the dataset array."},"dataset":{"type":"array","items":{"$ref":"#/components/schemas/FundraisingAsOfRecord"}},"hasMore":{"type":"boolean","description":"Whether another page exists. Present when limit was sent."},"nextId":{"type":"string","description":"Cursor for the next page — present only when hasMore is true. Pass it back as nextId (or lastRecordId)."},"minAvailableAt":{"type":"string","format":"date-time","nullable":true,"description":"Earliest snapshot timestamp in the dataset revisions — as-of queries cannot look further back."},"openingBalance":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credit balance before this request."},"closingBalance":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credit balance after this request."},"creditsConsumed":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credits charged for this request."}}},"example":{"code":200,"count":1,"dataset":[{"id":"67c858abf7fd1a188e2b1ab3","announcedDate":"2025-03-03","company":{"name":"Anthropic","domain":"anthropic.com","industries":["technology"],"location":"San Francisco,California,United States of America","ticker":[],"type":"Private"},"dealAmount":3500000000,"currency":"USD","fundingRound":"Series E","investors":"Lightspeed Venture Partners, Salesforce Ventures, Cisco Investments, Fidelity Management & Research Co., General Catalyst, D1 Capital Partners, Jane Street","leadInvestors":"Lightspeed Venture Partners","valuation":61500000000,"url":"https://www.investopedia.com/ai-startup-anthropic-valued-at-usd61-5b-after-latest-funding-round-11689703","title":"AI Startup Anthropic Valued at $61.5B After Latest Funding Round","lastModified":"2025-03-06","status":1,"version":1,"availableAt":"2026-10-14T02:00:00.000Z"}],"hasMore":true,"nextId":"67c858abf7fd1a188e2b1ab3","minAvailableAt":"2026-10-14T02:00:00.000Z"}}}}}}},"/api/dataset/layoff":{"post":{"tags":["Dataset API"],"summary":"Layoffs","description":"This REST API endpoint provides access to both ongoing and historical layoff data from the Intellizence Layoffs Dataset. Data access is limited to records within your subscription's entitled date range.\n\nUsers can search data using the following parameters:\n\n`dateType`, `startDate`, `endDate`, `date`, `companyDomain`, `companyName`, `companyIndustry`, `companyLocation`, `companyType`, `companyTicker`, `layoffType`, `layoffLocation`, and `layoffReason`.\n\nUsers can limit the number of records returned using the `limit` parameter. All parameters are optional.\nThe API key must be passed in the HTTP header as `x-api-key`.\n\n**Keeping a local copy in sync**: use `dateType: \"ANNOUNCED\"` for the initial historical pull (active records only), then poll with `dateType: \"LAST-MODIFIED\"` for daily updates. `LAST-MODIFIED` also returns records deactivated by our curation team — those carry `status: 0` so you can deactivate or delete them on your side.\n","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LayoffRequest"},"examples":{"getDailyUpdatedRecords":{"summary":"Get Daily Updated Records","value":{"dateType":"LAST-MODIFIED","date":"2026-03-03","limit":1}},"getLayoffsAnnouncedOnASpecificDate":{"summary":"Get Layoffs Announced on a Specific Date","value":{"dateType":"ANNOUNCED","date":"2026-03-03","limit":1}},"getLayoffsWithinADateRange":{"summary":"Get Layoffs Within a Date Range","value":{"dateType":"ANNOUNCED","startDate":"2026-03-01","endDate":"2026-03-31","limit":1}},"searchByCompanyDomain":{"summary":"Search by Company Domain","value":{"companyDomain":"dteenergy.com","limit":1}},"searchByCompanyIndustry":{"summary":"Search by Company Industry","value":{"companyIndustry":["technology","retail"],"limit":1}},"searchByCompanyLocation":{"summary":"Search by Company Location","value":{"companyLocation":"Detroit,Michigan,United States of America","limit":1}},"searchByLayoffLocation":{"summary":"Search by Layoff Location","value":{"layoffLocation":"Superior,Wisconsin,United States of America","limit":1}},"searchByLayoffType":{"summary":"Search by Layoff Type","value":{"layoffType":["Downsizing/Layoff","Permanent Plant Closure"],"limit":1}},"searchByLayoffReason":{"summary":"Search by Layoff Reason","value":{"layoffReason":["Restructuring","Cost-cutting"],"limit":1}},"useMultipleFiltersTogether":{"summary":"Use Multiple Filters Together","value":{"dateType":"ANNOUNCED","startDate":"2026-01-01","endDate":"2026-03-31","companyIndustry":["technology"],"companyType":["Public"],"layoffType":["Downsizing/Layoff"],"layoffReason":["Restructuring","Cost-cutting"],"layoffLocation":"United States of America","limit":1}},"dailyDataSync":{"summary":"Daily Data Sync","value":{"dateType":"LAST-MODIFIED","date":"2026-03-03","limit":1}},"cRMOrAccountRiskEnrichment":{"summary":"CRM or Account Risk Enrichment","value":{"companyDomain":"dteenergy.com","dateType":"LAST-MODIFIED","startDate":"2026-01-01","endDate":"2026-03-31","limit":1}},"sectorWorkforceTrendAnalysis":{"summary":"Sector Workforce Trend Analysis","value":{"dateType":"ANNOUNCED","startDate":"2026-01-01","endDate":"2026-03-31","companyIndustry":["technology"],"limit":1}},"wARNAndPlantClosureMonitoring":{"summary":"WARN and Plant Closure Monitoring","value":{"dateType":"ANNOUNCED","startDate":"2026-01-01","endDate":"2026-03-31","layoffType":["Permanent Plant Closure","Temporary Plant Closure"],"layoffLocation":"United States of America","limit":1}},"salesAndCustomerSuccessMonitoring":{"summary":"Sales and Customer Success Monitoring","value":{"dateType":"LAST-MODIFIED","startDate":"2026-01-01","endDate":"2026-03-31","companyIndustry":["technology"],"layoffReason":["Restructuring","Cost-cutting","Financial Distress"],"limit":1}}}}}},"responses":{"200":{"description":"Successful response — paginated layoff records.\nAlways check `code` in the body: 200 = success; 4xx/7xx values are business errors returned with HTTP 200 (see the `ErrorResponse` schema for the full code list).\nCredit fields (`openingBalance`, `closingBalance`, `creditsConsumed`) are returned only for Pay-Per-Use billing.\n","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","example":200},"count":{"type":"integer","description":"Number of records in the dataset array."},"dataset":{"type":"array","items":{"$ref":"#/components/schemas/LayoffRecord"}},"hasMore":{"type":"boolean","description":"Whether another page exists. Always present when 'limit' was sent."},"nextId":{"type":"string","description":"Cursor for the next page — present only when hasMore is true. Pass it back as 'nextId' (or 'lastRecordId')."},"openingBalance":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credit balance before this request."},"closingBalance":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credit balance after this request."},"creditsConsumed":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credits charged for this request."}}},"example":{"code":200,"count":1,"dataset":[{"id":"69a94b385c3136c85cd55f2c","announcedDate":"2026-03-03","company":{"name":"DTE Energy","domain":"dteenergy.com","industries":["energy & utilities"],"location":"Detroit,Michigan,United States of America","ticker":["DTE"],"stockExchange":["NYSE"],"type":"Public"},"layoffType":["Permanent Plant Closure"],"layoffReason":["Not Specified"],"businessDivision":"Midwest Energy Resources Co.","sourceType":"WARN Filings","location":{"country":"United States of America","state":"Wisconsin","city":"Superior"},"count":54,"url":"https://docs.google.com/spreadsheets/d/1rxOPsjFdc-XXJjNrg6C8wB1ll7T9Yg1-jKzck_qk3bo/edit?pli=1&gid=0#gid=0","title":"WARN Filings - March 2026","lastModified":"2026-03-05"}]}}}}}}},"/api/dataset/layoff/asof":{"post":{"tags":["Dataset API"],"summary":"Layoffs — Point-in-Time","description":"Returns the full dataset as it existed at `asof` — for every record, the latest revision at or before that timestamp. Intended for bulk consumers keeping a local mirror of the dataset.\n\n- `asof` is required — `YYYY-MM-DD` (treated as end of that day, UTC) or a full ISO datetime `YYYY-MM-DDTHH:mm:ssZ`.\n- Paginate with `limit` + `nextId` — pass the last record's `id` from the previous page.\n- `status` — `1` active, `0` deactivated by the curation team. Apply it locally to deactivate/delete the record.\n- `version` and `availableAt` identify the exact snapshot revision returned.\n- `company` (and the company objects inside records) reflect the **current** company profile, not the as-of state.\n- `minAvailableAt` in the response is the earliest snapshot timestamp — `asof` values before it return no data.","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsOfRequest"},"examples":{"datasetAsOfADate":{"summary":"Dataset as of a date","value":{"asof":"2026-10-15","limit":100}},"datasetAsOfATimestamp":{"summary":"Dataset as of a timestamp","value":{"asof":"2026-10-15T14:30:00Z","limit":100}},"nextPage":{"summary":"Next page","value":{"asof":"2026-10-15T00:00:00Z","limit":100,"nextId":"681bafcc22e1b135a7a6c137"}}}}}},"responses":{"200":{"description":"Successful response — point-in-time snapshot of layoff records.\nAlways check `code` in the body: 200 = success; 4xx/7xx values are business errors (see the `ErrorResponse` schema).\nCredit fields (`openingBalance`, `closingBalance`, `creditsConsumed`) are returned only for Pay-Per-Use billing.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","example":200},"count":{"type":"integer","description":"Number of records in the dataset array."},"dataset":{"type":"array","items":{"$ref":"#/components/schemas/LayoffAsOfRecord"}},"hasMore":{"type":"boolean","description":"Whether another page exists. Present when limit was sent."},"nextId":{"type":"string","description":"Cursor for the next page — present only when hasMore is true. Pass it back as nextId (or lastRecordId)."},"minAvailableAt":{"type":"string","format":"date-time","nullable":true,"description":"Earliest snapshot timestamp in the dataset revisions — as-of queries cannot look further back."},"openingBalance":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credit balance before this request."},"closingBalance":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credit balance after this request."},"creditsConsumed":{"type":"integer","nullable":true,"description":"Pay-per-use plans only — credits charged for this request."}}},"example":{"code":200,"count":1,"dataset":[{"id":"69a94b385c3136c85cd55f2c","announcedDate":"2026-03-03","company":{"name":"DTE Energy","domain":"dteenergy.com","industries":["energy & utilities"],"location":"Detroit,Michigan,United States of America","ticker":["DTE"],"stockExchange":["NYSE"],"type":"Public"},"layoffType":["Permanent Plant Closure"],"layoffReason":["Not Specified"],"businessDivision":"Midwest Energy Resources Co.","sourceType":"WARN Filings","location":{"country":"United States of America","state":"Wisconsin","city":"Superior"},"count":54,"url":"https://docs.google.com/spreadsheets/d/1rxOPsjFdc-XXJjNrg6C8wB1ll7T9Yg1-jKzck_qk3bo/edit?pli=1&gid=0#gid=0","title":"WARN Filings - March 2026","lastModified":"2026-03-05","status":1,"version":1,"availableAt":"2026-10-14T02:00:00.000Z"}],"hasMore":true,"nextId":"69a94b385c3136c85cd55f2c","minAvailableAt":"2026-10-14T02:00:00.000Z"}}}}}}},"/api/company-domains":{"get":{"tags":["Company & Trigger Configuration"],"summary":"Get Configured Company Domains","description":"Returns the company domains configured on your subscription for the given `resource` (e.g. `news.companies`, `dataset.mna`).\n\nAuthenticate with the `x-api-key` HTTP header.\n","parameters":[{"name":"resource","in":"query","required":true,"schema":{"type":"string","enum":["dataset.business_expansion","dataset.cxo_changes","dataset.data_security_breach","dataset.fundraising","dataset.layoff","dataset.mna","news.companies"]},"description":"Subscription resource key (e.g. news.companies, dataset.mna)."}],"security":[{"ApiKeyAuth":[]}],"responses":{"200":{"description":"Configured domains. Business errors return HTTP 200 with a `code` (see `ErrorResponse`).","content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"resource":{"type":"string"},"count":{"type":"integer"},"companyDomains":{"type":"array","items":{"type":"string"}}}}}}}}},"post":{"tags":["Company & Trigger Configuration"],"summary":"Add Company Domains","description":"Adds company domains to your subscription configuration. Domains are normalized (lowercased) and deduplicated; the merged list is returned.\nExceeding the plan's `maxCompaniesAllowed` is rejected with code `706`.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["resource","domains"],"properties":{"resource":{"type":"string","enum":["dataset.business_expansion","dataset.cxo_changes","dataset.data_security_breach","dataset.fundraising","dataset.layoff","dataset.mna","news.companies"],"example":"news.companies"},"domains":{"type":"array","items":{"type":"string"},"example":["tesla.com","apple.com"]}}}}}},"security":[{"ApiKeyAuth":[]}],"responses":{"200":{"description":"Updated configuration. Business errors return HTTP 200 with a `code` (see `ErrorResponse`).","content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"resource":{"type":"string"},"added":{"type":"integer","description":"Number of domains added."},"count":{"type":"integer","description":"Total configured domains after the add."},"companyDomains":{"type":"array","items":{"type":"string"}}}}}}}}},"delete":{"tags":["Company & Trigger Configuration"],"summary":"Delete Selected Company Domains","description":"Removes the given domains from your subscription configuration and returns the remaining list.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["resource","domains"],"properties":{"resource":{"type":"string","enum":["dataset.business_expansion","dataset.cxo_changes","dataset.data_security_breach","dataset.fundraising","dataset.layoff","dataset.mna","news.companies"],"example":"news.companies"},"domains":{"type":"array","items":{"type":"string"},"example":["apple.com"]}}}}}},"security":[{"ApiKeyAuth":[]}],"responses":{"200":{"description":"Remaining domains. Business errors return HTTP 200 with a `code` (see `ErrorResponse`).","content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"resource":{"type":"string"},"deleted":{"type":"integer"},"count":{"type":"integer"},"companyDomains":{"type":"array","items":{"type":"string"}}}}}}}}}},"/api/company-domains/upload":{"post":{"tags":["Company & Trigger Configuration"],"summary":"Upload Company Domains (CSV)","description":"Adds company domains from a CSV file (multipart/form-data, field `csv`, max 10 MB).\nThe first line is skipped when it looks like a header (contains \"domain\" or \"company\").\nComma-separated values on each line are all collected.\n","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["resource","csv"],"properties":{"resource":{"type":"string","enum":["dataset.business_expansion","dataset.cxo_changes","dataset.data_security_breach","dataset.fundraising","dataset.layoff","dataset.mna","news.companies"],"example":"news.companies"},"csv":{"type":"string","format":"binary"}}}}}},"security":[{"ApiKeyAuth":[]}],"responses":{"200":{"description":"Updated configuration (same shape as POST /api/company-domains). `745` is returned when no CSV file is attached.","content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"resource":{"type":"string"},"added":{"type":"integer"},"count":{"type":"integer"},"companyDomains":{"type":"array","items":{"type":"string"}}}}}}}}}},"/api/company-domains/all":{"delete":{"tags":["Company & Trigger Configuration"],"summary":"Delete All Company Domains","description":"Removes every configured company domain for the given resource.","parameters":[{"name":"resource","in":"query","required":true,"schema":{"type":"string","enum":["dataset.business_expansion","dataset.cxo_changes","dataset.data_security_breach","dataset.fundraising","dataset.layoff","dataset.mna","news.companies"]},"example":"news.companies"}],"security":[{"ApiKeyAuth":[]}],"responses":{"200":{"description":"Empty configuration. Business errors return HTTP 200 with a `code` (see `ErrorResponse`).","content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"resource":{"type":"string"},"count":{"type":"integer","example":0},"companyDomains":{"type":"array","items":{"type":"string"},"example":[]}}}}}}}}},"/api/trigger-codes":{"get":{"tags":["Company & Trigger Configuration"],"summary":"Get Configured Trigger Codes","description":"Returns the Intellizence trigger codes configured on your subscription for the given `resource`.\n","parameters":[{"name":"resource","in":"query","required":true,"schema":{"type":"string","enum":["dataset.business_expansion","dataset.cxo_changes","dataset.data_security_breach","dataset.fundraising","dataset.layoff","dataset.mna","news.companies"]},"example":"news.companies"}],"security":[{"ApiKeyAuth":[]}],"responses":{"200":{"description":"Configured trigger codes. Business errors return HTTP 200 with a `code` (see `ErrorResponse`).","content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"resource":{"type":"string"},"count":{"type":"integer"},"triggerCodes":{"type":"array","items":{"type":"string"}}}}}}}}},"post":{"tags":["Company & Trigger Configuration"],"summary":"Add Trigger Codes","description":"Adds trigger codes to your subscription configuration. Codes are deduplicated; the merged list is returned.\nExceeding the plan's `maxTriggersAllowed` is rejected with code `702`.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["resource","triggerCodes"],"properties":{"resource":{"type":"string","enum":["dataset.business_expansion","dataset.cxo_changes","dataset.data_security_breach","dataset.fundraising","dataset.layoff","dataset.mna","news.companies"],"example":"news.companies"},"triggerCodes":{"type":"array","items":{"type":"string"},"description":"Intellizence Trigger Code(s) to configure. Only codes configured in your subscription plan are used for news matching.\n\n| Code | Trigger |\n|------|---------|\n| `KW_143` | Advertisement / Branding / Campaign |\n| `KW_512` | Alliance & Partnership |\n| `KW_532` | Awards & Recognition |\n| `KW_584` | Bankruptcy |\n| `KW_641` | Branch/Store Closing |\n| `KW_640` | Branch/Store Opening |\n| `KW_527` | Business Expansion |\n| `KW_688` | Business Outlook & Projections |\n| `KW_586` | Business Shut-down |\n| `KW_535` | Buyout |\n| `KW_610` | Certification |\n| `KW_711` | Copyright / Patent / Trademark Dispute |\n| `KW_687` | Cost-Cutting |\n| `KW_556` | Customer Acquisition / Growth |\n| `KW_647` | Customer Loss / Growth Decline |\n| `KW_519` | Divestment |\n| `KW_528` | Downsizing (Layoff) |\n| `KW_677` | Employee Dispute & Strike |\n| `KW_591` | Executive Appointment |\n| `KW_502` | Executive Change |\n| `KW_741` | Executive Demise |\n| `KW_583` | Executive Statement |\n| `KW_510` | Financial Result |\n| `KW_514` | Fundraising |\n| `KW_534` | Going Private |\n| `KW_529` | Hiring |\n| `KW_616` | Industrial Accident & Disaster |\n| `KW_516` | Initial Public Offering |\n| `KW_708` | Investment |\n| `KW_513` | Joint Venture |\n| `KW_526` | Lawsuit / Judgment / Settlement |\n| `KW_585` | Legislation & Regulation |\n| `KW_518` | Merger & Acquisition |\n| `KW_666` | Merger & Acquisition Termination |\n| `KW_531` | Natural Disaster |\n| `KW_801` | New Initiatives and Programs |\n| `KW_521` | New Product Launch |\n| `KW_566` | New Service Launch |\n| `KW_536` | Organizational Restructuring |\n| `KW_601` | Outage |\n| `KW_14` | Pricing |\n| `KW_642` | Product Shutdown |\n| `KW_700` | Production Cut |\n| `KW_673` | Project & Operations Status |\n| `KW_533` | Promotion & Sale |\n| `KW_709` | Re-branding / Re-naming |\n| `KW_524` | Recall |\n| `KW_522` | Regulatory Approval |\n| `KW_613` | Regulatory Ban & Enforcement |\n| `KW_523` | Regulatory Investigation |\n| `KW_699` | Regulatory Settlement |\n| `KW_713` | Relocation |\n| `KW_589` | Research & Publications |\n| `KW_665` | Rumour & Speculation |\n| `KW_654` | Scandals & Frauds |\n| `KW_530` | Security Breach & Vulnerability |\n| `KW_678` | Shareholder Activism |\n| `KW_571` | Sourcing & Procurement |\n| `KW_520` | Spin-off |\n| `KW_537` | Startup Funding |\n| `KW_737` | Supply Chain Disruption |","example":["KW_518","KW_514"]}}}}}},"security":[{"ApiKeyAuth":[]}],"responses":{"200":{"description":"Updated configuration. Business errors return HTTP 200 with a `code` (see `ErrorResponse`).","content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"resource":{"type":"string"},"count":{"type":"integer"},"triggerCodes":{"type":"array","items":{"type":"string"}}}}}}}}},"delete":{"tags":["Company & Trigger Configuration"],"summary":"Delete Selected Trigger Codes","description":"Removes the given trigger codes from your subscription configuration and returns the remaining list.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["resource","triggerCodes"],"properties":{"resource":{"type":"string","enum":["dataset.business_expansion","dataset.cxo_changes","dataset.data_security_breach","dataset.fundraising","dataset.layoff","dataset.mna","news.companies"],"example":"news.companies"},"triggerCodes":{"type":"array","items":{"type":"string"},"example":["KW_514"]}}}}}},"security":[{"ApiKeyAuth":[]}],"responses":{"200":{"description":"Remaining trigger codes. Business errors return HTTP 200 with a `code` (see `ErrorResponse`).","content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"resource":{"type":"string"},"deleted":{"type":"integer"},"count":{"type":"integer"},"triggerCodes":{"type":"array","items":{"type":"string"}}}}}}}}}},"/api/trigger-codes/all":{"delete":{"tags":["Company & Trigger Configuration"],"summary":"Delete All Trigger Codes","description":"Removes every configured trigger code for the given resource.","parameters":[{"name":"resource","in":"query","required":true,"schema":{"type":"string","enum":["dataset.business_expansion","dataset.cxo_changes","dataset.data_security_breach","dataset.fundraising","dataset.layoff","dataset.mna","news.companies"]},"example":"news.companies"}],"security":[{"ApiKeyAuth":[]}],"responses":{"200":{"description":"Empty configuration. Business errors return HTTP 200 with a `code` (see `ErrorResponse`).","content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"resource":{"type":"string"},"count":{"type":"integer","example":0},"triggerCodes":{"type":"array","items":{"type":"string"},"example":[]}}}}}}}}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key issued to your subscription. Required on every request."}},"schemas":{"Company":{"type":"object","description":"Enriched company profile attached to each record.","properties":{"name":{"type":"string","nullable":true,"description":"Company name. The literal string \"Not specified\" may appear for unresolved companies."},"domain":{"type":"string","nullable":true,"description":"Canonical company domain (e.g. \"acme.com\")."},"industries":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Company industry classification by Intellizence."},"industrySegments":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Broader industry segments the company belongs to."},"location":{"type":"string","nullable":true,"description":"Company HQ location."},"type":{"type":"string","nullable":true,"description":"Company type (Public, Private, Government/Regulator, Not-for-profit, Others)."},"ticker":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Company stock ticker (if public)."},"stockExchange":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Stock exchange where the company is listed (if public)."}}},"ErrorResponse":{"type":"object","description":"Error envelope. The API returns HTTP 200 for business errors too — always check `code`.\n\n| code | message |\n|------|---------|\n| 406 | Invalid {deal amount / investment / valuation / jobs / people impacted} filter format |\n| 407 | Missing `currency code`. You have to pass `currency code` along with `deal amount` in request body. (For fundraising: also \"Invalid valuation filter format\") |\n| 408 | Missing `deal amount`. You have to pass `deal amount` along with `currency code` in request body. |\n| 701 | startDate must be in YYYY-MM-DD format |\n| 702 | endDate must be in YYYY-MM-DD format |\n| 703 | Plan or resource not subscribed by user |\n| 704 | Payment pending for this subscription. |\n| 705 | Plan not found |\n| 706 | Resource not in plan |\n| 707 | Subscription expired for this plan. |\n| 708 | Requested data is outside your allowed start date. Change the request start date or upgrade for historical access. |\n| 711 | Invalid creditsPerRow for payPerUse subscription |\n| 712 | Unable to debit credits (insufficient pay-per-use credits) |\n| 713 | Invalid request configuration (e.g. missing subscription config keys) |\n| 714 | Download not allowed for this plan |\n| 715 | Failed to fetch {dataset} records |\n| 799 | Internal server error |\n\nConfiguration APIs (`/api/company-domains*`, `/api/trigger-codes*`) use a separate code space:\n700 = email is required, 701 = resource is required, 702 = invalid/no valid domains or trigger codes\n(also: max allowed exceeded), 703 = customer not found, 704 = active subscription for this resource not found,\n706 = max companies allowed exceeded, 707 = invalid query, 745 = csv file is required,\n799 = internal server error.\n","properties":{"code":{"type":"integer"},"message":{"type":"string"},"details":{"type":"string","nullable":true,"description":"Underlying error detail when available."}}},"IndustryEnum":{"type":"string","enum":["accounting, audit & tax","advertising & communication","agriculture, animal husbandry & forestry","angels/ venture capital/ private equity","automobile","aviation","banking","bio-technology","business services","chemicals & fertilizers","clean technology","conglomerate","consulting","consumer products","consumer services","defence","distribution","e-commerce","economic development","education","energy & utilities","engineering, procurement & construction","financial services","gambling","gaming","government","healthcare","human resources","insurance","it services & outsourcing","legal","logistics & supply chain","manufacturing","media & entertainment","medical device","metals & mining","not-for-profit/ ngo","others","pharmaceuticals","publishing","railways","real estate","regulatory","restaurants & food services","retail","security","shipping & ports","spac/blank check","sports","technology","telecommunication","textiles","tourism & hospitality","trading","transportation"]},"CompanyTypeEnum":{"type":"string","enum":["Public","Private","Government/Regulator","Not-for-profit","Others"]},"CurrencyEnum":{"type":"string","enum":["USD","CAD","EUR","GBP","INR","AUD","CHF","CNY","JPY","SEK"]},"MnaRequest":{"type":"object","description":"Request body for M&A deals search. All filters combine with AND.","properties":{"dateType":{"type":"string","enum":["ANNOUNCED","LAST-MODIFIED"],"default":"ANNOUNCED","example":"ANNOUNCED","description":"Choose the date type used to filter records (case-sensitive). The default is `ANNOUNCED`.\n\n- `ANNOUNCED` — filters on `announcedDate`. Use for historical backfill — returns only active records.\n- `LAST-MODIFIED` — filters on `lastModified`. Use for daily/incremental sync — returns records created, modified, **or deactivated** in the window. Deactivated records carry `status: 0` — apply it on your side to deactivate or delete the record locally. `status` is present in the response only when `dateType` is `LAST-MODIFIED`.\n"},"startDate":{"type":"string","format":"date","example":"2025-02-24","description":"The start date (YYYY-MM-DD) from which M&A deals data is required. The Intellizence Mergers & Acquisitions Dataset contains data beginning from 2020-01-01. Access to historical data may vary depending on your subscription plan."},"endDate":{"type":"string","format":"date","example":"2025-02-24","description":"The end date (YYYY-MM-DD) up to which M&A deals data is required."},"date":{"type":"string","format":"date","example":"2025-02-24","description":"Exact date (YYYY-MM-DD) for which the M&A deals data is required."},"acquiringCompanyName":{"type":"string","example":"Blackstone","description":"The name of the acquiring company for which the M&A deals data is required. Partial name matches are supported. Multiple values can be provided either as a comma-separated string or as an array. Ignored when acquiringCompanyDomain is also sent."},"acquiringCompanyDomain":{"type":"string","example":"blackstone.com","description":"The website domain of the acquiring company (exact match; the 'www.' prefix is ignored). Multiple values can be provided either as a comma-separated string or as an array. When sent, it takes precedence over acquiringCompanyName."},"acquiringCompanyIndustry":{"allOf":[{"$ref":"#/components/schemas/IndustryEnum"},{"example":"financial services","description":"The industry of the acquiring companies for which M&A deals data is required. The industries are pre-defined by Intellizence and only the values listed below will be accepted. Multiple values should be provided as an array."}]},"acquiringCompanyIndustrySegment":{"type":"string","description":"The industry segment of the acquiring companies for which M&A deals data is required."},"acquiringCompanyLocation":{"type":"string","example":"New York City,New York,United States of America","description":"The HeadQuarters location of the acquiring companies for which M&A deals data is required. The location can be City or State/Province or Country. Multiple values can be provided either as a comma-separated string or as an array."},"acquiringCompanyType":{"allOf":[{"$ref":"#/components/schemas/CompanyTypeEnum"},{"example":"Public","description":"The company type of the acquiring companies for which M&A deals data is required. The company types are pre-defined by Intellizence and only the values listed below will be accepted. Multiple values can be provided either as a comma-separated string or as an array."}]},"acquiringCompanyTicker":{"type":"string","example":"BX","description":"Acquiring company stock ticker if it's a public company."},"acquiredCompanyName":{"type":"string","example":"Safe Harbor Marinas","description":"The name of the acquired company for which the M&A deals data is required. Partial name matches are supported. Multiple values can be provided either as a comma-separated string or as an array. Ignored when acquiredCompanyDomain is also sent."},"acquiredCompanyDomain":{"type":"string","example":"shmarinas.com","description":"The website domain of the acquired company (exact match; the 'www.' prefix is ignored). Multiple values can be provided either as a comma-separated string or as an array. When sent, it takes precedence over acquiredCompanyName."},"acquiredCompanyIndustry":{"allOf":[{"$ref":"#/components/schemas/IndustryEnum"},{"example":"shipping & ports","description":"The industry of the acquired companies for which M&A deals data is required. The industries are pre-defined by Intellizence and only the values listed below will be accepted. Multiple values should be provided as an array."}]},"acquiredCompanyIndustrySegment":{"type":"string","description":"The industry segment of the acquired companies for which M&A deals data is required."},"acquiredCompanyLocation":{"type":"string","example":"Fontana,California,United States of America","description":"The HeadQuarters location of the acquired companies for which M&A deals data is required. The location can be City or State/Province or Country. Multiple values can be provided either as a comma-separated string or as an array."},"acquiredCompanyType":{"allOf":[{"$ref":"#/components/schemas/CompanyTypeEnum"},{"example":"Private","description":"The company type of the acquired companies for which M&A deals data is required. The company types are pre-defined by Intellizence and only the values listed below will be accepted. Multiple values can be provided either as a comma-separated string or as an array."}]},"acquiredCompanyTicker":{"type":"string","description":"Acquired company stock ticker if it's a public company."},"sellingCompanyName":{"type":"string","example":"Sun Communities","description":"The name of the selling company for which the M&A deals data is required. Partial matches are supported. Ignored when sellingCompanyDomain is also sent."},"sellingCompanyDomain":{"type":"string","example":"suncommunities.com","description":"The website domain of the selling company (exact match; the 'www.' prefix is ignored). When sent, it takes precedence over sellingCompanyName."},"sellingCompanyIndustry":{"allOf":[{"$ref":"#/components/schemas/IndustryEnum"},{"example":"real estate","description":"The industry of the selling companies for which M&A deals data is required. The industries are pre-defined by Intellizence and only the values listed below will be accepted. Multiple values should be provided as an array."}]},"sellingCompanyIndustrySegment":{"type":"string","description":"The industry segment of the selling companies for which M&A deals data is required."},"sellingCompanyLocation":{"type":"string","example":"Southfield,Michigan,United States of America","description":"The HeadQuarters location of the selling companies for which M&A deals data is required. The location can be City or State/Province or Country."},"sellingCompanyType":{"allOf":[{"$ref":"#/components/schemas/CompanyTypeEnum"},{"example":"Public","description":"The company type of the selling companies for which M&A deals data is required. The company types are pre-defined by Intellizence and only the values listed below will be accepted. Multiple values can be provided either as a comma-separated string or as an array."}]},"sellingCompanyTicker":{"type":"string","example":"SUI","description":"Selling company stock ticker if it's a public company."},"dealAmount":{"type":"string","pattern":"^(>=|>|<=|<|=|!=)\\d+$|^\\d+,\\d+$","example":">=1000000","description":"Filter M&A deals data by deal amount. `currency` must be sent along with `dealAmount` —\nrequests with `dealAmount` but no `currency` are rejected (code 407), and `currency`\nwithout `dealAmount` is rejected (code 408).\nAllowed operators: `>`, `>=`, `<`, `<=`, `=`, `!=`, or `min,max` range.\nExamples: `>1000000`, `>=1000000`, `<1000000`, `<=1000000`, `=1000000`, `!=1000000`, `1000000,400000`\n"},"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyEnum"},{"example":"USD","description":"The currency of the deal transaction. Required when `dealAmount` is sent; sending `currency` alone is rejected."}]},"mnaStatus":{"type":"string","enum":["Announced","Completed","Terminated","Rumours & Speculation","Bid/Offer","In Discussion/Negotiation","Shareholder Approved","Shareholder Rejected","Board Rejected","Regulator Review","Regulator Approved","Regulator Rejected","Legal Dispute"],"example":"Announced","description":"Filter M&A deals data based on M&A status. The common status are Announced, Completed and Terminated."},"mnaType":{"type":"string","enum":["Acquisition - Total","Acquisition - Asset / Business Division Sale","Acquisition - Financial Stake","Acquisition - Joint Venture Stake","Merger","Merger - Business Operations","Merger - Internal Operations/Subsidiaries","Reverse Takeover","Tender Offer","Acqui-hire","Other"],"example":"Acquisition - Total","description":"Filter M&A deals data by M&A type (filters the `typeOfAcquisition` record field)."},"limit":{"type":"integer","example":100,"description":"The maximum number of records to be returned."},"lastRecordId":{"type":"string","description":"Alias of `nextId` — the `id` of the last record on the current page."},"nextId":{"type":"string","description":"Cursor for the next page — pass the `nextId` value from the previous response."},"prevId":{"type":"string","description":"Cursor for the previous page (records before this id in sort order)."}}},"MnaCompany":{"type":"object","nullable":true,"description":"Enriched company profile for a deal role.","properties":{"name":{"type":"string","nullable":true,"description":"Company name."},"domain":{"type":"string","nullable":true,"description":"Company website domain."},"industries":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Industries associated with the company."},"location":{"type":"string","nullable":true,"description":"HQ location of the company (City,State/Province,Country)."},"type":{"type":"string","nullable":true,"description":"Company type (Public, Private, Government/Regulator, Not-for-profit, Others)."},"ticker":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Stock ticker symbol(s) of the company (if public)."},"stockExchange":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Stock exchange(s) the ticker trades on."}}},"MnaRecord":{"type":"object","description":"An M&A deal record.","properties":{"announcedDate":{"type":"string","format":"date","example":"2025-02-24","description":"Merger/Acquisition announced date (YYYY-MM-DD)."},"acquiringCompany":{"allOf":[{"$ref":"#/components/schemas/MnaCompany"},{"example":{"name":"Blackstone","domain":"blackstone.com","industries":["angels/ venture capital/ private equity","financial services"],"location":"New York City,New York,United States of America","type":"Private","ticker":["BX"]}}]},"acquiredCompany":{"allOf":[{"$ref":"#/components/schemas/MnaCompany"},{"example":{"name":"Safe Harbor Marinas","domain":"shmarinas.com","industries":["shipping & ports"],"location":"Fontana,California,United States of America","type":"Private"}}]},"sellingCompany":{"allOf":[{"$ref":"#/components/schemas/MnaCompany"},{"description":"Present only when a divesting company is involved; omitted otherwise.","example":{"name":"Sun Communities","domain":"suncommunities.com","industries":["real estate"],"location":"Southfield,Michigan,United States of America","type":"Public","ticker":["SUI"]}}]},"typeOfAcquisition":{"type":"string","nullable":true,"example":"Acquisition - Total","description":"Merger & Acquisition type (request filter name: `mnaType`)."},"mnaStatus":{"type":"string","nullable":true,"example":"Announced","description":"Merger & Acquisition deal status."},"dealAmount":{"type":"number","nullable":true,"description":"The deal amount if publicly disclosed."},"currency":{"type":"string","nullable":true,"example":"USD","description":"The currency of the deal transaction."},"id":{"type":"string","example":"67bd5c88f7fd1a188e2b0ea1","description":"Unique ID of the record."},"newsId":{"type":"string","nullable":true,"description":"Identifier of the underlying news/signal record (`hash` in the signals collection)."},"lastModified":{"type":"string","format":"date","example":"2025-02-25","description":"The last modified date of the record (YYYY-MM-DD)."},"title":{"type":"string","nullable":true,"example":"Blackstone Infrastructure to Acquire Safe Harbor Marinas in $5.65B Transaction","description":"Source title — news or press release headline."},"url":{"type":"string","nullable":true,"example":"https://www.businesswire.com/news/home/20250224590051/en/Blackstone-Infrastructure-to-Acquire-Safe-Harbor-Marinas-in-5.65B-Transaction/","description":"URL of the source document (tracking parameters stripped)."},"version":{"type":"integer","description":"Record version — 0 on insert, incremented on every curation update."},"status":{"type":"integer","enum":[1,0],"description":"Record status — `1` active, `0` deactivated by the curation team. Only present when `dateType` is `LAST-MODIFIED`; treat `0` as a delete on your side."}}},"BusinessExpansionRequest":{"type":"object","description":"Request body for business expansion search. All filters combine with AND.","properties":{"dateType":{"type":"string","enum":["ANNOUNCED","LAST-MODIFIED"],"default":"ANNOUNCED","example":"ANNOUNCED","description":"Choose the date type used to filter records (case-sensitive). The default is `ANNOUNCED`.\n\n- `ANNOUNCED` — filters on `announcedDate`. Use for historical backfill — returns only active records.\n- `LAST-MODIFIED` — filters on `lastModified`. Use for daily/incremental sync — returns records created, modified, **or deactivated** in the window. Deactivated records carry `status: 0` — apply it on your side to deactivate or delete the record locally. `status` is present in the response only when `dateType` is `LAST-MODIFIED`.\n"},"startDate":{"type":"string","format":"date","example":"2025-02-24","description":"The start date (YYYY-MM-DD) from which business expansion data is needed. The Intellizence Business Expansion Dataset contains data beginning from 2021-01-01."},"endDate":{"type":"string","format":"date","example":"2025-02-24","description":"The end date (YYYY-MM-DD) up to which business expansion data is needed."},"date":{"type":"string","format":"date","example":"2025-02-24","description":"Exact date (YYYY-MM-DD) for which the business expansion data is needed."},"companyName":{"type":"string","description":"The name(s) of the company for which business expansion data is needed. Partial name matching is supported. Multiple values can be provided either as a comma-separated string or as an array. Ignored when companyDomain is also sent."},"companyDomain":{"type":"string","description":"The website domain(s) of the company for which the business expansion data is needed (exact match; the 'www.' prefix is ignored). When sent, it takes precedence over companyName. Multiple values can be provided either as a comma-separated string or as an array."},"companyIndustry":{"allOf":[{"$ref":"#/components/schemas/IndustryEnum"},{"description":"The industry or industries of companies for which business expansion data is needed. The industries are pre-defined by Intellizence and only the values listed below will be accepted. Multiple values should be provided as an array."}]},"companyIndustrySegment":{"type":"string","description":"The industry segment(s) of companies for which business expansion data is needed. Exact match. Multiple values can be provided either as a comma-separated string or as an array."},"companyLocation":{"type":"string","description":"The location of the company headquarters for which business expansion data is needed. The location can be specified as a city, state/province, or country. Multiple values can be provided either as a comma-separated string or as an array."},"companyType":{"allOf":[{"$ref":"#/components/schemas/CompanyTypeEnum"},{"description":"The type of company or organization for which business expansion data is needed. The company types are pre-defined by Intellizence and only the values listed below will be accepted. Multiple values can be provided either as a comma-separated string or as an array."}]},"companyTicker":{"type":"string","description":"Stock ticker of the company (if public). Multiple values can be provided either as a comma-separated string or as an array."},"expansionType":{"type":"string","enum":["Store","Restaurant","Data Centre","Factory/Plant","Country Expansion","HQ","Mine","Branch/Office","Oil/Gas Well","Other","Product/Service Availability","Research/Lab/Innovation","Renewables","Fulfillment/Distribution Centre/Warehouse","New Business","Fleet","Route","Airport/Airline Hub/Cargo Facility","Healthcare Facility","Hotel/Resort","Delivery/Pickup","Education","Lease/Land Purchase"],"description":"Type of expansion for which data is needed. Multiple values can be provided either as a comma-separated string or as an array."},"expansionLocation":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Location where the expansion is announced (city, state/province or country)."},"investment":{"type":"string","pattern":"^(>=|>|<=|<|=|!=)\\d+$|^\\d+,\\d+$","description":"Filter the records by expansion investment amount. currency must be sent along with investment — investment without currency is rejected (code 407) and currency alone is rejected (code 408).\nAllowed operators: >, >=, <, <=, =, !=, or a min,max range.\nExamples: >1000000, >=1000000, <1000000, <=1000000, =1000000, !=1000000, 1000000,400000\n"},"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyEnum"},{"example":"USD","description":"The currency of the deal transaction. Required when investment is sent; sending currency alone is rejected (code 408)."}]},"jobs":{"type":"string","pattern":"^(>=|>|<=|<|=|!=)\\d+$|^\\d+,\\d+$","description":"Number of jobs created.\nAllowed operators: >, >=, <, <=, =, !=, or a min,max range.\nExamples: >1000000, >=1000000, <1000000, <=1000000, =1000000, !=1000000, 1000000,400000\n"},"limit":{"type":"integer","example":1,"description":"The maximum number of records to be returned."},"lastRecordId":{"type":"string","description":"Alias of nextId — the id of the last record on the current page."},"nextId":{"type":"string","description":"Cursor for the next page — pass the nextId value from the previous response. (The lastRecordId alias is also accepted.)"},"prevId":{"type":"string","description":"Cursor for the previous page (records before this id in sort order)."}}},"BusinessExpansionRecord":{"type":"object","description":"A business expansion record.","properties":{"announcedDate":{"type":"string","example":"24/02/2025","description":"Business expansion announced date (DD/MM/YYYY)."},"company":{"$ref":"#/components/schemas/Company"},"expansionType":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Type of expansion."},"location":{"type":"object","nullable":true,"description":"Location where the expansion is announced","properties":{"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}}},"investment":{"type":"number","nullable":true,"description":"Expansion investment amount."},"currency":{"type":"string","nullable":true,"description":"The currency of the investment amount."},"jobs":{"type":"integer","nullable":true,"description":"Number of jobs created."},"id":{"type":"string","description":"Unique ID of the record.","example":"67bd5c88f7fd1a188e2b0ea1"},"newsId":{"type":"string","nullable":true,"description":"Identifier of the underlying news/signal record."},"lastModified":{"type":"string","example":"25/02/2025","description":"The last modified date of the record (DD/MM/YYYY)."},"title":{"type":"string","nullable":true,"description":"Source title — news or press release headline"},"url":{"type":"string","nullable":true,"description":"URL of the source document (tracking parameters stripped)."},"version":{"type":"integer","description":"Record version — 0 on insert, incremented on every curation update."},"status":{"type":"integer","enum":[1,0],"description":"Record status — `1` active, `0` deactivated by the curation team. Only present when `dateType` is `LAST-MODIFIED`; treat `0` as a delete on your side."}}},"DataBreachRequest":{"type":"object","description":"Request body for data & security breach search. All filters combine with AND.","properties":{"dateType":{"type":"string","enum":["ANNOUNCED","LAST-MODIFIED"],"default":"ANNOUNCED","example":"ANNOUNCED","description":"Choose the date type used to filter records (case-sensitive). The default is `ANNOUNCED`.\n\n- `ANNOUNCED` — filters on `announcedDate`. Use for historical backfill — returns only active records.\n- `LAST-MODIFIED` — filters on `lastModified`. Use for daily/incremental sync — returns records created, modified, **or deactivated** in the window. Deactivated records carry `status: 0` — apply it on your side to deactivate or delete the record locally. `status` is present in the response only when `dateType` is `LAST-MODIFIED`.\n"},"startDate":{"type":"string","format":"date","example":"2025-02-24","description":"The start date (YYYY-MM-DD) from which data & security breaches data is needed. The Intellizence Data and Security Breaches Dataset contains data beginning from 2022-01-01."},"endDate":{"type":"string","format":"date","example":"2025-02-24","description":"The end date (YYYY-MM-DD) up to which data & security breaches data is needed."},"date":{"type":"string","format":"date","example":"2025-02-24","description":"Exact date (YYYY-MM-DD) for which the data & security breaches data is needed."},"companyName":{"type":"string","description":"The name(s) of the company for which data & security breaches data is needed. Partial name matching is supported. Multiple values can be provided either as a comma-separated string or as an array. Ignored when companyDomain is also sent."},"companyDomain":{"type":"string","description":"The website domain(s) of the company for which the data & security breaches data is needed (exact match; the 'www.' prefix is ignored). When sent, it takes precedence over companyName. Multiple values can be provided either as a comma-separated string or as an array."},"companyIndustry":{"allOf":[{"$ref":"#/components/schemas/IndustryEnum"},{"description":"The industry or industries of companies for which data & security breaches data is needed. The industries are pre-defined by Intellizence and only the values listed below will be accepted. Multiple values should be provided as an array."}]},"companyIndustrySegment":{"type":"string","description":"The industry segment(s) of companies for which data & security breaches data is needed. Exact match. Multiple values can be provided either as a comma-separated string or as an array."},"companyLocation":{"type":"string","description":"The location of the company headquarters for which data & security breaches data is needed. The location can be specified as a city, state/province, or country. Multiple values can be provided either as a comma-separated string or as an array."},"companyType":{"allOf":[{"$ref":"#/components/schemas/CompanyTypeEnum"},{"description":"The type of company or organization for which data & security breaches data is needed. The company types are pre-defined by Intellizence and only the values listed below will be accepted. Multiple values can be provided either as a comma-separated string or as an array."}]},"companyTicker":{"type":"string","description":"Stock ticker of the company (if public). Multiple values can be provided either as a comma-separated string or as an array."},"incidentType":{"type":"string","enum":["Data Breach/Theft/Leak","Security Breach","Ransomware","Malware","DDOS","POS Attack","Hack","Others"],"description":"The type of cyber security incident. The incident types are pre-defined by Intellizence and only the values listed below will be accepted. Multiple values can be provided either as a comma-separated string or as an array."},"peopleImpacted":{"type":"string","pattern":"^(>=|>|<=|<|=|!=)\\d+$|^\\d+,\\d+$","description":"Filter records by number of people impacted due to the cyber security incident.\nAllowed operators: >, >=, <, <=, =, !=, or a min,max range.\nExamples: >1000000, >=1000000, <1000000, <=1000000, =1000000, !=1000000, 1000000,400000\n"},"limit":{"type":"integer","example":1,"description":"The maximum number of records to be returned."},"lastRecordId":{"type":"string","description":"Alias of nextId — the id of the last record on the current page."},"nextId":{"type":"string","description":"Cursor for the next page — pass the nextId value from the previous response. (The lastRecordId alias is also accepted.)"},"prevId":{"type":"string","description":"Cursor for the previous page (records before this id in sort order)."}}},"DataBreachRecord":{"type":"object","description":"A data / security breach record.","properties":{"announcedDate":{"type":"string","example":"24/02/2025","description":"Date of incident announcement (DD/MM/YYYY)."},"company":{"$ref":"#/components/schemas/Company"},"incidentType":{"type":"string","nullable":true,"description":"Type of cyber security incident."},"peopleImpacted":{"type":"integer","nullable":true,"description":"Number of people impacted due to the cyber security incident."},"incidentDate":{"type":"string","format":"date","nullable":true,"description":"Date the incident occurred or was disclosed to regulators (YYYY-MM-DD)."},"thirdPartyCompany":{"type":"object","nullable":true,"description":"Third-party company whose product/services caused this cyber security incident (if disclosed). Available only for records created after May 1, 2025.","properties":{"name":{"type":"string","nullable":true},"domain":{"type":"string","nullable":true}}},"sourceType":{"type":"string","nullable":true,"description":"Source type of the incident announcement — News/Press Wires, Regulatory Filings. Available only for records created after May 1, 2025."},"id":{"type":"string","description":"Unique ID of the record.","example":"67bd5c88f7fd1a188e2b0ea1"},"newsId":{"type":"string","nullable":true,"description":"Identifier of the underlying news/signal record."},"lastModified":{"type":"string","example":"25/02/2025","description":"The last modified date of the record (DD/MM/YYYY)."},"title":{"type":"string","nullable":true,"description":"Source title — news, press release or regulatory filing headline"},"url":{"type":"string","nullable":true,"description":"URL of the source document (tracking parameters stripped)."},"version":{"type":"integer","description":"Record version — 0 on insert, incremented on every curation update."},"status":{"type":"integer","enum":[1,0],"description":"Record status — `1` active, `0` deactivated by the curation team. Only present when `dateType` is `LAST-MODIFIED`; treat `0` as a delete on your side."}}},"ExecutiveChangeRequest":{"type":"object","description":"Request body for C-Suite changes search. All filters combine with AND.","properties":{"dateType":{"type":"string","enum":["ANNOUNCED","LAST-MODIFIED"],"default":"ANNOUNCED","example":"ANNOUNCED","description":"Choose the date type used to filter records (case-sensitive). The default is `ANNOUNCED`.\n\n- `ANNOUNCED` — filters on `announcedDate`. Use for historical backfill — returns only active records.\n- `LAST-MODIFIED` — filters on `lastModified`. Use for daily/incremental sync — returns records created, modified, **or deactivated** in the window. Deactivated records carry `status: 0` — apply it on your side to deactivate or delete the record locally. `status` is present in the response only when `dateType` is `LAST-MODIFIED`.\n"},"startDate":{"type":"string","format":"date","example":"2025-02-24","description":"The start date (YYYY-MM-DD) from which C-Suite changes data is needed. The Intellizence C-Suite Changes Dataset contains data beginning from 2021-01-01."},"endDate":{"type":"string","format":"date","example":"2025-02-24","description":"The end date (YYYY-MM-DD) up to which C-Suite changes data is needed."},"date":{"type":"string","format":"date","example":"2025-02-24","description":"Exact date (YYYY-MM-DD) for which the C-Suite changes data is needed."},"companyName":{"type":"string","description":"The name(s) of the company for which C-Suite changes data is needed. Partial name matching is supported. Multiple values can be provided either as a comma-separated string or as an array. Ignored when companyDomain is also sent."},"companyDomain":{"type":"string","description":"The website domain(s) of the company for which the C-Suite changes data is needed (exact match; the 'www.' prefix is ignored). When sent, it takes precedence over companyName. Multiple values can be provided either as a comma-separated string or as an array."},"companyIndustry":{"allOf":[{"$ref":"#/components/schemas/IndustryEnum"},{"description":"The industry or industries of companies for which C-Suite changes data is needed. The industries are pre-defined by Intellizence and only the values listed below will be accepted. Multiple values should be provided as an array."}]},"companyIndustrySegment":{"type":"string","description":"The industry segment(s) of companies for which C-Suite changes data is needed. Exact match. Multiple values can be provided either as a comma-separated string or as an array."},"companyLocation":{"type":"string","description":"The location of the company headquarters for which C-Suite changes data is needed. The location can be specified as a city, state/province, or country. Multiple values can be provided either as a comma-separated string or as an array."},"companyType":{"allOf":[{"$ref":"#/components/schemas/CompanyTypeEnum"},{"description":"The type of company or organization for which C-Suite changes data is needed. The company types are pre-defined by Intellizence and only the values listed below will be accepted. Multiple values can be provided either as a comma-separated string or as an array."}]},"companyTicker":{"type":"string","description":"Stock ticker of the company (if public). Multiple values can be provided either as a comma-separated string or as an array."},"executiveName":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Name of the C-Level executive whose role is changed."},"executiveTitle":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Title of the C-Level executive whose role is changed."},"executiveTitleCategory":{"type":"string","enum":["Chief Executive Officer (CEO)/President/Managing Director","Chair/Vice-Chair","Board of Director","Chief Operating Officer (COO)","Chief Financial Officer (CFO) / Head of Finance","Chief Investment Officer (CIO)","Chief Information Officer (CIO) / Head of IT","Chief Technology Officer (CTO)","Chief Product Officer (CPO) / Head of Product","Chief Risk Officer (CRO) / Head of Risk","Chief Information Security Officer (CISO)","Chief Human Resource / People Officer","Chief Marketing Officer (CMO)","Chief Revenue Officer (CRO) / Head of Sales","Head of Customer Success/Support","Other"],"description":"Title category of the C-Level executive whose role is changed. The title categories are pre-defined by Intellizence and only the values listed below will be accepted. Multiple values can be provided either as a comma-separated string or as an array."},"reason":{"type":"string","enum":["New Appointment","Promoted/Role Change","Retired","Terminated","Health","Resigned","Demise","Others"],"description":"The reason for the executive change."},"limit":{"type":"integer","example":1,"description":"The maximum number of records to be returned."},"lastRecordId":{"type":"string","description":"Alias of nextId — the id of the last record on the current page."},"nextId":{"type":"string","description":"Cursor for the next page — pass the nextId value from the previous response. (The lastRecordId alias is also accepted.)"},"prevId":{"type":"string","description":"Cursor for the previous page (records before this id in sort order)."}}},"ExecutiveChangeRecord":{"type":"object","description":"A C-Suite / executive change record.","properties":{"announcedDate":{"type":"string","example":"24/02/2025","description":"C-Level executive change announced date (DD/MM/YYYY)."},"company":{"$ref":"#/components/schemas/Company"},"executiveName":{"type":"string","nullable":true,"description":"Name of the C-Level executive whose role is changed."},"executiveTitle":{"type":"string","nullable":true,"description":"Title of the C-Level executive whose role is changed."},"executiveTitleCategory":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Title category of the C-Level executive whose role is changed."},"reason":{"type":"array","items":{"type":"string"},"nullable":true,"description":"The reason for the executive change."},"effectiveDate":{"type":"string","format":"date","nullable":true,"description":"Effective date of the role change (YYYY-MM-DD)."},"id":{"type":"string","description":"Unique ID of the record.","example":"67bd5c88f7fd1a188e2b0ea1"},"newsId":{"type":"string","nullable":true,"description":"Identifier of the underlying news/signal record."},"lastModified":{"type":"string","example":"25/02/2025","description":"The last modified date of the record (DD/MM/YYYY)."},"title":{"type":"string","nullable":true,"description":"Source title — news or press release headline"},"url":{"type":"string","nullable":true,"description":"URL of the source document (tracking parameters stripped)."},"version":{"type":"integer","description":"Record version — 0 on insert, incremented on every curation update."},"status":{"type":"integer","enum":[1,0],"description":"Record status — `1` active, `0` deactivated by the curation team. Only present when `dateType` is `LAST-MODIFIED`; treat `0` as a delete on your side."}}},"FundraisingRequest":{"type":"object","description":"Request body for startup funding & VC deals search. All filters combine with AND.","properties":{"dateType":{"type":"string","enum":["ANNOUNCED","LAST-MODIFIED"],"default":"ANNOUNCED","example":"ANNOUNCED","description":"Choose the date type used to filter records (case-sensitive). The default is `ANNOUNCED`.\n\n- `ANNOUNCED` — filters on `announcedDate`. Use for historical backfill — returns only active records.\n- `LAST-MODIFIED` — filters on `lastModified`. Use for daily/incremental sync — returns records created, modified, **or deactivated** in the window. Deactivated records carry `status: 0` — apply it on your side to deactivate or delete the record locally. `status` is present in the response only when `dateType` is `LAST-MODIFIED`.\n"},"startDate":{"type":"string","format":"date","example":"2025-02-24","description":"The start date (YYYY-MM-DD) from which funding data is needed. The Intellizence Startup Funding Dataset contains data beginning from 2020-01-01."},"endDate":{"type":"string","format":"date","example":"2025-02-24","description":"The end date (YYYY-MM-DD) up to which funding data is needed."},"date":{"type":"string","format":"date","example":"2025-02-24","description":"Exact date (YYYY-MM-DD) for which the funding data is needed."},"companyName":{"type":"string","description":"The name(s) of the company for which funding data is needed. Partial name matching is supported. Multiple values can be provided either as a comma-separated string or as an array. Ignored when companyDomain is also sent."},"companyDomain":{"type":"string","description":"The website domain(s) of the company for which the funding data is needed (exact match; the 'www.' prefix is ignored). When sent, it takes precedence over companyName. Multiple values can be provided either as a comma-separated string or as an array."},"companyIndustry":{"allOf":[{"$ref":"#/components/schemas/IndustryEnum"},{"description":"The industry or industries of companies for which funding data is needed. The industries are pre-defined by Intellizence and only the values listed below will be accepted. Multiple values should be provided as an array."}]},"companyIndustrySegment":{"type":"string","description":"The industry segment(s) of companies for which funding data is needed. Exact match. Multiple values can be provided either as a comma-separated string or as an array."},"companyLocation":{"type":"string","description":"The location of the company headquarters for which funding data is needed. The location can be specified as a city, state/province, or country. Multiple values can be provided either as a comma-separated string or as an array."},"companyType":{"allOf":[{"$ref":"#/components/schemas/CompanyTypeEnum"},{"description":"The type of company or organization for which funding data is needed. The company types are pre-defined by Intellizence and only the values listed below will be accepted. Multiple values can be provided either as a comma-separated string or as an array."}]},"companyTicker":{"type":"string","description":"Stock ticker of the company (if public). Multiple values can be provided either as a comma-separated string or as an array."},"fundingRound":{"type":"string","enum":["Angel","Crowdfunding","Pre-Seed","Seed","Post-Seed / Pre-Series A","Series A","Series B","Series C","Series D","Series E","Series F","Series G","Series H","Series I","Series J","Private Equity","Secondary Offering","Venture - Series Unknown","Debt Financing","Corporate Round","Grant"],"description":"The funding round for which data is needed. Multiple values can be provided either as a comma-separated string or as an array."},"dealAmount":{"type":"string","pattern":"^(>=|>|<=|<|=|!=)\\d+$|^\\d+,\\d+$","description":"Filter the records by funding deal amount. currency must be sent along with dealAmount — dealAmount without currency is rejected (code 407) and currency alone is rejected (code 408).\nAllowed operators: >, >=, <, <=, =, !=, or a min,max range.\nExamples: >1000000, >=1000000, <1000000, <=1000000, =1000000, !=1000000, 1000000,400000\n"},"valuation":{"type":"string","pattern":"^(>=|>|<=|<|=|!=)\\d+$|^\\d+,\\d+$","description":"Filter records based on company valuation. Valuation data is not available for all records and is typically provided only for companies with valuations in the billion-dollar range.\nAllowed operators: >, >=, <, <=, =, !=, or a min,max range.\nExamples: >1000000, >=1000000, <1000000, <=1000000, =1000000, !=1000000, 1000000,400000\n"},"investor":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Name of the investor(s) who invested in the round (partial match against the investors list)."},"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyEnum"},{"example":"USD","description":"The currency of the deal transaction. Required when dealAmount is sent; sending currency alone is rejected (code 408)."}]},"limit":{"type":"integer","example":1,"description":"The maximum number of records to be returned."},"lastRecordId":{"type":"string","description":"Alias of nextId — the id of the last record on the current page."},"nextId":{"type":"string","description":"Cursor for the next page — pass the nextId value from the previous response. (The lastRecordId alias is also accepted.)"},"prevId":{"type":"string","description":"Cursor for the previous page (records before this id in sort order)."}}},"FundraisingRecord":{"type":"object","description":"A startup funding / VC deal record.","properties":{"announcedDate":{"type":"string","example":"24/02/2025","description":"Funding announced date (DD/MM/YYYY)."},"company":{"$ref":"#/components/schemas/Company"},"fundingRound":{"type":"string","nullable":true,"description":"Funding round."},"investors":{"oneOf":[{"type":"string","nullable":true},{"type":"array","items":{"type":"string"}}],"description":"Name(s) of the investors who invested in this round."},"leadInvestors":{"oneOf":[{"type":"string","nullable":true},{"type":"array","items":{"type":"string"}}],"description":"Name(s) of the lead investors who invested in this round."},"dealAmount":{"type":"number","nullable":true,"description":"The deal amount if publicly disclosed."},"currency":{"type":"string","nullable":true,"description":"The currency of the deal transaction."},"valuation":{"type":"number","nullable":true,"description":"The valuation amount if publicly disclosed."},"valuationCurrency":{"type":"string","nullable":true,"description":"The currency of the valuation amount."},"investmentProceeds":{"type":"string","nullable":true,"description":"Intended use of the raised funds (e.g. working capital), if disclosed."},"unicorn":{"type":"boolean","nullable":true,"description":"True when the round takes the company valuation above $1B."},"id":{"type":"string","description":"Unique ID of the record.","example":"67bd5c88f7fd1a188e2b0ea1"},"newsId":{"type":"string","nullable":true,"description":"Identifier of the underlying news/signal record."},"lastModified":{"type":"string","example":"25/02/2025","description":"The last modified date of the record (DD/MM/YYYY)."},"title":{"type":"string","nullable":true,"description":"Source title — news or press release headline"},"url":{"type":"string","nullable":true,"description":"URL of the source document (tracking parameters stripped)."},"version":{"type":"integer","description":"Record version — 0 on insert, incremented on every curation update."},"status":{"type":"integer","enum":[1,0],"description":"Record status — `1` active, `0` deactivated by the curation team. Only present when `dateType` is `LAST-MODIFIED`; treat `0` as a delete on your side."}}},"LayoffRequest":{"type":"object","description":"Request body for layoff data search. All filters combine with AND.","properties":{"dateType":{"type":"string","enum":["ANNOUNCED","LAST-MODIFIED"],"default":"ANNOUNCED","example":"ANNOUNCED","description":"Choose the date type used to filter records (case-sensitive). The default is `ANNOUNCED`.\n\n- `ANNOUNCED` — filters on `announcedDate`. Use for historical backfill — returns only active records.\n- `LAST-MODIFIED` — filters on `lastModified`. Use for daily/incremental sync — returns records created, modified, **or deactivated** in the window. Deactivated records carry `status: 0` — apply it on your side to deactivate or delete the record locally. `status` is present in the response only when `dateType` is `LAST-MODIFIED`.\n"},"startDate":{"type":"string","format":"date","example":"2025-02-24","description":"The start date (YYYY-MM-DD) from which layoff data is needed. The Intellizence Layoff Dataset contains data beginning from 2020-01-01."},"endDate":{"type":"string","format":"date","example":"2025-02-24","description":"The end date (YYYY-MM-DD) up to which layoff data is needed."},"date":{"type":"string","format":"date","example":"2025-02-24","description":"Exact date (YYYY-MM-DD) for which the layoff data is needed."},"companyName":{"type":"string","description":"The name(s) of the company for which layoff data is needed. Partial name matching is supported. Multiple values can be provided either as a comma-separated string or as an array. Ignored when companyDomain is also sent."},"companyDomain":{"type":"string","description":"The website domain(s) of the company for which the layoff data is needed (exact match; the 'www.' prefix is ignored). When sent, it takes precedence over companyName. Multiple values can be provided either as a comma-separated string or as an array."},"companyIndustry":{"allOf":[{"$ref":"#/components/schemas/IndustryEnum"},{"description":"The industry or industries of companies for which layoff data is needed. The industries are pre-defined by Intellizence and only the values listed below will be accepted. Multiple values should be provided as an array."}]},"companyIndustrySegment":{"type":"string","description":"The industry segment(s) of companies for which layoff data is needed. Exact match. Multiple values can be provided either as a comma-separated string or as an array."},"companyLocation":{"type":"string","description":"The location of the company headquarters for which layoff data is needed. The location can be specified as a city, state/province, or country. Multiple values can be provided either as a comma-separated string or as an array."},"companyType":{"allOf":[{"$ref":"#/components/schemas/CompanyTypeEnum"},{"description":"The type of company or organization for which layoff data is needed. The company types are pre-defined by Intellizence and only the values listed below will be accepted. Multiple values can be provided either as a comma-separated string or as an array."}]},"companyTicker":{"type":"string","description":"Stock ticker of the company (if public). Multiple values can be provided either as a comma-separated string or as an array."},"layoffType":{"type":"string","enum":["Downsizing/Layoff","Furlough/Temporary","Hiring Freeze","Voluntary Retirement","Temporary Plant Closure","Permanent Plant Closure","Voluntary Separation Program","Other"],"description":"The type of layoff/job cut. The layoff types are pre-defined by Intellizence and only the values listed below will be accepted. Multiple values can be provided either as a comma-separated string or as an array."},"layoffLocation":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"The location of the company where layoff was announced (city, state/province or country)."},"layoffReason":{"type":"string","enum":["Economic Crisis","Pandemic","Restructuring","Cost-cutting","M&A","Automation","Outsourcing","Privatization","Trade Tariff/Treaty","Business Closure","Relocation","Not Specified","Divestment","Contract Loss","Loss of Funding","Sales Decline","Other","Bankruptcy","Financial Distress","Production Cut","Employee Strike","IPO","Staff Redundancies","Voluntary Dismissal","Employees Performance Metrics","Strategic and Business Changes","Annual Review Process","AI Automation","Natural Disaster"],"description":"Layoff reason mentioned in the source. The layoff reasons are pre-defined by Intellizence and only the values listed below will be accepted. Multiple values can be provided either as a comma-separated string or as an array."},"limit":{"type":"integer","example":1,"description":"The maximum number of records to be returned."},"lastRecordId":{"type":"string","description":"Alias of nextId — the id of the last record on the current page."},"nextId":{"type":"string","description":"Cursor for the next page — pass the nextId value from the previous response. (The lastRecordId alias is also accepted.)"},"prevId":{"type":"string","description":"Cursor for the previous page (records before this id in sort order)."}}},"LayoffRecord":{"type":"object","description":"A layoff / workforce reduction record.","properties":{"announcedDate":{"type":"string","example":"24/02/2025","description":"Date of layoff announcement (DD/MM/YYYY)."},"company":{"$ref":"#/components/schemas/Company"},"count":{"type":"number","nullable":true,"description":"Number of employees laid off, if disclosed as an absolute number."},"percent":{"type":"number","nullable":true,"description":"Percentage of employees laid off, if disclosed as a percentage."},"location":{"type":"object","nullable":true,"description":"Layoff location","properties":{"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}}},"layoffType":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Type of layoff/job cut."},"layoffReason":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Layoff reason mentioned in the source."},"businessDivision":{"type":"string","nullable":true,"description":"Business division where the layoff was announced."},"sourceType":{"type":"string","nullable":true,"description":"Source type of the layoff announcement — WARN Filings, News/Press Wires. Available only for records created after May 1, 2025."},"id":{"type":"string","description":"Unique ID of the record.","example":"67bd5c88f7fd1a188e2b0ea1"},"newsId":{"type":"string","nullable":true,"description":"Identifier of the underlying news/signal record."},"lastModified":{"type":"string","example":"25/02/2025","description":"The last modified date of the record (DD/MM/YYYY)."},"title":{"type":"string","nullable":true,"description":"Source title — news, press release or WARN notice headline"},"url":{"type":"string","nullable":true,"description":"URL of the source document (tracking parameters stripped)."},"version":{"type":"integer","description":"Record version — 0 on insert, incremented on every curation update."},"status":{"type":"integer","enum":[1,0],"description":"Record status — `1` active, `0` deactivated by the curation team. Only present when `dateType` is `LAST-MODIFIED`; treat `0` as a delete on your side."}}},"NewsSearchRequest":{"type":"object","description":"Request body for company news signals search. All filters combine with AND.","properties":{"startDate":{"type":"string","format":"date","example":"2026-09-01","description":"News published start date. Enter the date in YYYY-MM-DD format."},"endDate":{"type":"string","format":"date","example":"2026-09-30","description":"News published end date (YYYY-MM-DD). Defaults to today when omitted."},"companyDomains":{"type":"array","items":{"type":"string"},"example":["tesla.com"],"description":"Website domain of the companies for which news signals are required. Multiple domains can be passed as an array (the 'www.' prefix is ignored, matching is exact). Only domains configured in your subscription plan are searched."},"industries":{"type":"array","items":{"type":"string"},"description":"Restrict news to companies in the given Intellizence industries or industry segments (exact-match values)."},"locations":{"type":"array","items":{"type":"string"},"description":"Restrict news to companies headquartered in the given location(s)."},"companyTypes":{"type":"array","items":{"type":"string"},"description":"Restrict news to companies of the given type(s) — e.g. Public, Private, Government/Regulator, Not-for-profit, Others."},"stockMarkets":{"type":"array","items":{"type":"string"},"description":"Restrict news to companies listed on the given stock exchanges."},"triggerCodes":{"type":"array","items":{"type":"string"},"example":["KW_518","KW_514"],"description":"Intellizence Trigger Codes used to filter relevant news signals. Multiple Trigger Code(s) can be passed as an array. Only trigger codes configured in your subscription plan are searched.\n\n| Code | Trigger |\n|------|---------|\n| `KW_143` | Advertisement / Branding / Campaign |\n| `KW_512` | Alliance & Partnership |\n| `KW_532` | Awards & Recognition |\n| `KW_584` | Bankruptcy |\n| `KW_641` | Branch/Store Closing |\n| `KW_640` | Branch/Store Opening |\n| `KW_527` | Business Expansion |\n| `KW_688` | Business Outlook & Projections |\n| `KW_586` | Business Shut-down |\n| `KW_535` | Buyout |\n| `KW_610` | Certification |\n| `KW_711` | Copyright / Patent / Trademark Dispute |\n| `KW_687` | Cost-Cutting |\n| `KW_556` | Customer Acquisition / Growth |\n| `KW_647` | Customer Loss / Growth Decline |\n| `KW_519` | Divestment |\n| `KW_528` | Downsizing (Layoff) |\n| `KW_677` | Employee Dispute & Strike |\n| `KW_591` | Executive Appointment |\n| `KW_502` | Executive Change |\n| `KW_741` | Executive Demise |\n| `KW_583` | Executive Statement |\n| `KW_510` | Financial Result |\n| `KW_514` | Fundraising |\n| `KW_534` | Going Private |\n| `KW_529` | Hiring |\n| `KW_616` | Industrial Accident & Disaster |\n| `KW_516` | Initial Public Offering |\n| `KW_708` | Investment |\n| `KW_513` | Joint Venture |\n| `KW_526` | Lawsuit / Judgment / Settlement |\n| `KW_585` | Legislation & Regulation |\n| `KW_518` | Merger & Acquisition |\n| `KW_666` | Merger & Acquisition Termination |\n| `KW_531` | Natural Disaster |\n| `KW_801` | New Initiatives and Programs |\n| `KW_521` | New Product Launch |\n| `KW_566` | New Service Launch |\n| `KW_536` | Organizational Restructuring |\n| `KW_601` | Outage |\n| `KW_14` | Pricing |\n| `KW_642` | Product Shutdown |\n| `KW_700` | Production Cut |\n| `KW_673` | Project & Operations Status |\n| `KW_533` | Promotion & Sale |\n| `KW_709` | Re-branding / Re-naming |\n| `KW_524` | Recall |\n| `KW_522` | Regulatory Approval |\n| `KW_613` | Regulatory Ban & Enforcement |\n| `KW_523` | Regulatory Investigation |\n| `KW_699` | Regulatory Settlement |\n| `KW_713` | Relocation |\n| `KW_589` | Research & Publications |\n| `KW_665` | Rumour & Speculation |\n| `KW_654` | Scandals & Frauds |\n| `KW_530` | Security Breach & Vulnerability |\n| `KW_678` | Shareholder Activism |\n| `KW_571` | Sourcing & Procurement |\n| `KW_520` | Spin-off |\n| `KW_537` | Startup Funding |\n| `KW_737` | Supply Chain Disruption |"},"limit":{"type":"integer","default":100,"example":100,"description":"Maximum number of records to return."},"nextId":{"type":"string","description":"Cursor for the next page — pass the 'id' of the last news record from the previous response. (The nextCursor alias is also accepted.)"}}},"SimilarNewsItem":{"type":"object","description":"Related/clustered article for a news record.","properties":{"hash":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"desc":{"type":"string","nullable":true},"publisher":{"type":"string","nullable":true},"url":{"type":"string","format":"uri","nullable":true},"publishDate":{"type":"string","format":"date-time","nullable":true}}},"NewsItem":{"type":"object","description":"A company news signal.","properties":{"publishDate":{"type":"string","format":"date","description":"Date the article was published (YYYY-MM-DD)."},"companyNames":{"type":"array","items":{"type":"string"},"description":"Company name(s) the article is about."},"companyDomains":{"type":"array","items":{"type":"string"},"description":"Company domain(s) the article is about."},"triggerNames":{"type":"array","items":{"type":"string"},"description":"Human-readable trigger names matched by the article."},"triggerCodes":{"type":"array","items":{"type":"string"},"description":"Intellizence Trigger Codes matched by the article."},"similarNews":{"type":"array","items":{"$ref":"#/components/schemas/SimilarNewsItem"},"description":"Clustered or related articles for this news record."},"id":{"type":"string","description":"Unique ID of the news record. Pass back as 'nextId' for pagination."},"title":{"type":"string","nullable":true,"description":"News article headline."},"url":{"type":"string","format":"uri","nullable":true,"description":"URL of the news article."},"desc":{"type":"string","nullable":true,"description":"Short description/summary of the article."},"publisher":{"type":"string","nullable":true,"description":"Publisher of the article."}}},"StatusResponse":{"type":"object","description":"Generic v1 API envelope. `status` carries the business result (200 = OK, 201/202/404 = domain result codes). Error bodies additionally carry `status: -1` and an `error` string (HTTP 400/500).","properties":{"status":{"type":"integer","example":200},"message":{"type":"string","example":"OK"}}},"CompanyLookup":{"type":"object","description":"Slim company record returned by company search.","properties":{"id":{"type":"string","description":"Intellizence company id."},"name":{"type":"string"},"domain":{"type":"string"}}},"TrackedCompany":{"type":"object","description":"Company record used by the v1 tracking APIs (search results and tracked lists).","properties":{"id":{"type":"string","nullable":true,"description":"Intellizence company id."},"name":{"type":"string","nullable":true},"domain":{"type":"string","nullable":true},"industries":{"type":"array","items":{"type":"string"},"nullable":true},"industrySegments":{"type":"array","items":{"type":"string"},"nullable":true},"location":{"type":"string","nullable":true,"description":"HQ location (City,State,Country)."},"stockExchanges":{"type":"array","items":{"type":"string"},"nullable":true},"tickers":{"type":"array","items":{"type":"string"},"nullable":true},"type":{"type":"string","nullable":true,"description":"Public, Private, etc."},"employeeCount":{"type":"integer","nullable":true}}},"AsOfRequest":{"type":"object","required":["asof"],"description":"Request body for point-in-time dataset queries — returns each record as of the latest revision at or before `asof`.","properties":{"asof":{"type":"string","format":"date-time","example":"2026-10-15T00:00:00Z","description":"Snapshot timestamp — every record is returned in the state of its latest revision at or before this time.\nAccepts `YYYY-MM-DD` (treated as end of that day, UTC) or a full ISO datetime `YYYY-MM-DDTHH:mm:ssZ`.\n"},"limit":{"type":"integer","default":100,"example":100,"description":"Maximum number of records per page."},"nextId":{"type":"string","description":"Pagination cursor — pass the `id` of the last record from the previous page. `lastRecordId` is also accepted."}}},"MnaAsOfRecord":{"allOf":[{"$ref":"#/components/schemas/MnaRecord"},{"type":"object","properties":{"availableAt":{"type":"string","format":"date-time","example":"2026-10-19T16:20:00.000Z","description":"Timestamp of the snapshot revision returned for this record."}}}]},"BusinessExpansionAsOfRecord":{"allOf":[{"$ref":"#/components/schemas/BusinessExpansionRecord"},{"type":"object","properties":{"availableAt":{"type":"string","format":"date-time","example":"2026-10-19T16:20:00.000Z","description":"Timestamp of the snapshot revision returned for this record."}}}]},"DataBreachAsOfRecord":{"allOf":[{"$ref":"#/components/schemas/DataBreachRecord"},{"type":"object","properties":{"availableAt":{"type":"string","format":"date-time","example":"2026-10-19T16:20:00.000Z","description":"Timestamp of the snapshot revision returned for this record."}}}]},"ExecutiveChangeAsOfRecord":{"allOf":[{"$ref":"#/components/schemas/ExecutiveChangeRecord"},{"type":"object","properties":{"availableAt":{"type":"string","format":"date-time","example":"2026-10-19T16:20:00.000Z","description":"Timestamp of the snapshot revision returned for this record."}}}]},"FundraisingAsOfRecord":{"allOf":[{"$ref":"#/components/schemas/FundraisingRecord"},{"type":"object","properties":{"availableAt":{"type":"string","format":"date-time","example":"2026-10-19T16:20:00.000Z","description":"Timestamp of the snapshot revision returned for this record."}}}]},"LayoffAsOfRecord":{"allOf":[{"$ref":"#/components/schemas/LayoffRecord"},{"type":"object","properties":{"availableAt":{"type":"string","format":"date-time","example":"2026-10-19T16:20:00.000Z","description":"Timestamp of the snapshot revision returned for this record."}}}]}}}}