Search companies
GET {{baseUrl}}/search?freeText=Company X
Search companies matching query string parameters.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
requestKey | string | Used when paging in a previous searched result | |
pageSize | string | Number of results to return per pagination page | |
from | string | first result to return from the resultset that is being paged through | |
town | string | Town the searched for company should be registered in | |
town | string | Town the searched for company should be registered in | |
commune | string | Commune the searched for company should be registered in | |
commune | string | Commune the searched for company should be registered in | |
zipCode | string | Zip code the searched for company should be registered in | |
zipCode | string | Zip code the searched for company should be registered in | |
countryCode | string | Country code the searched for company should be registered in | |
countryCode | string | Country code the searched for company should be registered in | |
industryCode | string | The primary industry code the company to search for belongs to | |
industryCode | string | The primary industry code the company to search for belongs to | |
legalGroupCode | string | The legal group code for the type of company to search for | |
insektCode | string | The institutional sector code for company to search for | |
bankruptcy | string | The searched for company should be in bankruptcy, true/false | |
deleted | string | The searched for company should be deleted, true/false | |
settlementReg | string | The searched for company should be under liquidation, true/false | |
compulsorySettlementOrLiquidation | string | The searched for company should be under forced liquidation or dissolution, true/false | |
vatReg | string | The searched for company should be registered for VAT, true/false | |
frivillighetsregisteretReg | string | The searched for company should be registered in free will vat registry, true/false | |
stiftelseregisteretReg | string | The searched for company should be registered in founder registry, true/false | |
foretaksregisteretReg | string | The searched for company should be registered in enterprise registry, true/false | |
companyRegistrationDate | string | The date the company searched for should have been registered, range input with : between is accepted | |
numberCompanyUnits | string | Number of units the company searched for should have, range input with : between is accepted | |
numberEmployees | string | Number of employees the company searched for should have, range input with : between is accepted | |
legalGroupText | string | The legal group name for the type of company to search for | |
legalGroupText | string | The legal group name for the type of company to search for | |
freeText | string | Search by either company name, company id, unit name or unit orgId | |
plNetSales | string | Net sales, range type, tkr |
RESPONSES
status: OK
{"hitCount":"\u003cinteger\u003e","hits":[{"companyId":"\u003cstring\u003e","companyName":"\u003cstring\u003e","legalGroupCode":"\u003cstring\u003e","legalGroupText":"\u003cstring\u003e","town":"\u003cstring\u003e"},{"companyId":"\u003cstring\u003e","companyName":"\u003cstring\u003e","legalGroupCode":"\u003cstring\u003e","legalGroupText":"\u003cstring\u003e","town":"\u003cstring\u003e"}],"metrics":{"bankruptcy":"\u003cobject\u003e","commune":"\u003cobject\u003e","compulsorySettlementOrLiquidation":"\u003cobject\u003e","countryCode":"\u003cobject\u003e","deleted":"\u003cobject\u003e","foretaksregisteretReg":"\u003cobject\u003e","frivillighetsregisteretReg":"\u003cobject\u003e","industryCode":"\u003cobject\u003e","insektCode":"\u003cobject\u003e","legalGroupCode":"\u003cobject\u003e","numberCompanyUnits":"\u003cobject\u003e","numberEmployees":"\u003cobject\u003e","settlementReg":"\u003cobject\u003e","stiftelseregisteretReg":"\u003cobject\u003e","town":"\u003cobject\u003e","vatReg":"\u003cobject\u003e","zipCode":"\u003cobject\u003e"},"next":"\u003cstring\u003e","previous":"\u003cstring\u003e","requestKey":"\u003cstring\u003e"}