Search companies

GET {{baseUrl}}/search?freeText=Company X

Search companies matching query string parameters.

Request Params

KeyDatatypeRequiredDescription
requestKeystringUsed when paging in a previous searched result
pageSizestringNumber of results to return per pagination page
fromstringfirst result to return from the resultset that is being paged through
townstringTown the searched for company should be registered in
townstringTown the searched for company should be registered in
communestringCommune the searched for company should be registered in
communestringCommune the searched for company should be registered in
zipCodestringZip code the searched for company should be registered in
zipCodestringZip code the searched for company should be registered in
countryCodestringCountry code the searched for company should be registered in
countryCodestringCountry code the searched for company should be registered in
industryCodestringThe primary industry code the company to search for belongs to
industryCodestringThe primary industry code the company to search for belongs to
legalGroupCodestringThe legal group code for the type of company to search for
insektCodestringThe institutional sector code for company to search for
bankruptcystringThe searched for company should be in bankruptcy, true/false
deletedstringThe searched for company should be deleted, true/false
settlementRegstringThe searched for company should be under liquidation, true/false
compulsorySettlementOrLiquidationstringThe searched for company should be under forced liquidation or dissolution, true/false
vatRegstringThe searched for company should be registered for VAT, true/false
frivillighetsregisteretRegstringThe searched for company should be registered in free will vat registry, true/false
stiftelseregisteretRegstringThe searched for company should be registered in founder registry, true/false
foretaksregisteretRegstringThe searched for company should be registered in enterprise registry, true/false
companyRegistrationDatestringThe date the company searched for should have been registered, range input with : between is accepted
numberCompanyUnitsstringNumber of units the company searched for should have, range input with : between is accepted
numberEmployeesstringNumber of employees the company searched for should have, range input with : between is accepted
legalGroupTextstringThe legal group name for the type of company to search for
legalGroupTextstringThe legal group name for the type of company to search for
freeTextstringSearch by either company name, company id, unit name or unit orgId
plNetSalesstringNet 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"}