# Layoff Dataset API

## Submit Layoff Dataset Request

> This API endpoint allows users to access real-time and historical layoff announcement data. \
> \
> Users can search data using various parameters- \`dateType\`,\`startDate\`,\`endDate\`,\`date\`,\`companyDomain\`,\`companyName\`,\`companyIndustry\`,\`companyLocation\`,\`companyType\`, \`companyTicker\`,\`layoffType\`, \`layoffLocation\`, and \`layoffReason\`. \
> \
> All the parameters are optional. Users can limit the number of records returned using the \`limit\` parameter. \
> \
> The API key has to be passed in HTTP header with the name \`x-api-key\`.

```json
{"openapi":"3.0.3","info":{"title":"Intellizence Layoffs Dataset API","version":"2.0"},"servers":[{"url":"https://api.intellizence.com"}],"paths":{"/api/v2/dataset/layoff":{"post":{"summary":"Submit Layoff Dataset Request","description":"This API endpoint allows users to access real-time and historical layoff announcement data. \n\nUsers can search data using various parameters- `dateType`,`startDate`,`endDate`,`date`,`companyDomain`,`companyName`,`companyIndustry`,`companyLocation`,`companyType`, `companyTicker`,`layoffType`, `layoffLocation`, and `layoffReason`. \n\nAll the parameters are optional. Users can limit the number of records returned using the `limit` parameter. \n\nThe API key has to be passed in HTTP header with the name `x-api-key`.","operationId":"getLayoffDataset","parameters":[{"name":"x-api-key","in":"header","description":"Intellizence API key for authenticating the request.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Intellizence Layoff Dataset request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dataset_layoff_body"}}}},"responses":{"200":{"description":"Successful response, returns the Layoff  dataset record(s)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/inline_response_200"}}}},"400":{"description":"Bad request, possibly missing required parameters, invalid data, invalid or missing API key"},"404":{"description":"Available credits are 0"},"405":{"description":"Insufficient credits"},"500":{"description":"Internal server error"}}}}},"components":{"schemas":{"dataset_layoff_body":{"type":"object","properties":{"dateType":{"type":"string","description":"Choose the date type used to filter records.The default value is 'ANNOUNCED'. To get the daily update of records created or modified, 'LAST-MODIFIED' is recommended.","enum":["ANNOUNCED","LAST-MODIFIED"]},"startDate":{"type":"string","description":"The start date (YYYY-MM-DD) from which layoff data is needed. The Intellizence Layoff Dataset contains data beginning from 2020-01-01.","format":"date"},"endDate":{"type":"string","description":"The end date (YYYY-MM-DD) up to which layoff data is needed.","format":"date"},"date":{"type":"string","description":"Exact date (YYYY-MM-DD) for which the layoff data is needed.","format":"date"},"companyName":{"type":"string","description":"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."},"companyDomain":{"type":"string","description":"The website domain(s) of the company for which the layoff data is needed. Partial domain matching is supported. Multiple values can be provided either as a comma-separated string or as an array."},"companyIndustry":{"type":"string","description":"The industry or industries of the companies for which layoff data is requested. Industries are predefined by Intellizence, and only the values listed below are supported. Multiple values can be provided as an array.","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"]},"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":{"type":"string","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.","enum":["Public","Private","Government/Regulator","Not-for-profit","Others"]},"companyTicker":{"type":"string","description":"Stock ticker of the company"},"layoffType":{"type":"string","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.","enum":["Downsizing/Layoff","Furlough/Temporary","Hiring Freeze","Voluntary Retirement","Temporary Plant Closure","Permanent Plant Closure","Voluntary Separation Program","Other"]},"layoffReason":{"type":"string","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.","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 Redudancies","Voluntary Dismissal","Employees Performance Metrics","Strategic and Business Changes","Annual Review Process","AI Automation","Natural Disaster"]},"layoffLocation":{"type":"string","description":"The location of the company where layoff was announced. 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."},"limit":{"type":"integer","description":"The maximum number of records to be returned."}}},"inline_response_200":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the record"},"announcedDate":{"type":"string","description":"Date of layoff announcement","format":"date"},"company":{"$ref":"#/components/schemas/inline_response_200_company"},"count":{"type":"number","description":"Number of people laid off. The value can be absolute number OR percentage depends on how the company disclosed.","format":"float"},"location":{"$ref":"#/components/schemas/inline_response_200_location"},"layoffType":{"type":"string","description":"Type of layoff/job cut"},"layoffReason":{"type":"string","description":"Layoff reason mentioned in the source"},"businessDivision":{"type":"string","description":"Business Division where the layoff was announced"},"sourceType":{"type":"string","description":"Source type of the layoff announcement - WARN Filings, News/Press Wires. The values for this data point are available only for records that were created after May 1st, 2025."},"lastModified":{"type":"string","description":"The last modified date of the record.","format":"date"},"title":{"type":"string","description":"Source title - News or press release or WARN Notice headline"},"url":{"type":"string","description":"URL of the source document"}}},"inline_response_200_company":{"type":"object","properties":{"name":{"type":"string","description":"Company name"},"domain":{"type":"string","description":"Company website domain"},"industries":{"type":"array","description":"Company industry classification by Intellizence","items":{"type":"string"}},"location":{"type":"string","description":"Company HQ location"},"type":{"type":"string","description":"Company type"},"ticker":{"type":"array","description":"Company stock ticker (if public)","items":{"type":"string"}},"stockExchange":{"type":"array","description":"Stock exchange where the company is listed (if public)","items":{"type":"string"}}}},"inline_response_200_location":{"type":"object","properties":{"country":{"type":"string"},"state":{"type":"string"},"city":{"type":"string"}},"description":"Layoff location"}}}}
```