{"components":{"schemas":{"BadRequest":{"description":"Returned when something is wrong in the request, e.g. failed argument validation or missed argument","properties":{"attributes":{"description":"Invalid attributes","items":{"$ref":"#/components/schemas/RequestAttribute"},"type":"array"},"error":{"default":"BadRequest","description":"Error name","type":"string"},"message":{"default":"Required arguments are missing in the request","description":"Description of the request error","type":"string"}},"type":"object"},"CompanySearchResult":{"description":"Roaring Apps company search. list contains all possible fields returned","properties":{"hitCount":{"description":"Total hit count","format":"int32","type":"integer"},"hits":{"description":"Array of hits on the search","items":{"$ref":"#/components/schemas/SearchHit"},"type":"array"},"metrics":{"allOf":[{"$ref":"#/components/schemas/MetricsResult"}],"description":"Metrics connected to the search"},"next":{"description":"url for fetching the next page of search data","type":"string"},"previous":{"description":"url for fetching the previous page of search data","type":"string"},"requestKey":{"description":"Request key","type":"string"}},"type":"object"},"MetricsResult":{"description":"Metrics connected to the search","properties":{"industryCode":{"additionalProperties":{"format":"int32","type":"integer"},"maxProperties":100,"type":"object"},"legalGroupCode":{"additionalProperties":{"format":"int32","type":"integer"},"maxProperties":100,"type":"object"},"numberEmployeesInterval":{"additionalProperties":{"format":"int32","type":"integer"},"maxProperties":100,"type":"object"},"plNetOperatingIncome":{"additionalProperties":{"format":"int32","type":"integer"},"maxProperties":100,"type":"object"},"statusCode":{"additionalProperties":{"format":"int32","type":"integer"},"maxProperties":100,"type":"object"},"town":{"additionalProperties":{"format":"int32","type":"integer"},"maxProperties":100,"type":"object"},"vatReg":{"additionalProperties":{"format":"int32","type":"integer"},"maxProperties":100,"type":"object"},"zipCode":{"additionalProperties":{"format":"int32","type":"integer"},"maxProperties":100,"type":"object"}},"type":"object"},"RequestAttribute":{"description":"Incorrect attribute of request","properties":{"attribute":{"description":"Parameter name","type":"string"},"value":{"description":"Parameter value, subject for validation","type":"string"}},"type":"object"},"SearchHit":{"description":"hit of the search","properties":{"companyId":{"type":"string"},"companyName":{"description":"Name of the company","type":"string"},"historicalName":{"description":"Populated when this hit was surfaced by matching a historical company name. Holds the historical name that matched the query; the current name is in companyName.","type":"string"},"legalGroupCode":{"description":"Which kind of company it is","type":"string"},"legalGroupText":{"description":"Description of which kind of company it is","type":"string"},"town":{"description":"The Town the company resides in","type":"string"}},"type":"object"},"ServerError":{"description":"Internal server error","properties":{"error":{"default":"InternalServerError","description":"Error name","type":"string"},"message":{"default":"An internal server error occurred, please contact the system administrator with information on the error","description":"Description of the request error","type":"string"}},"type":"object"}},"securitySchemes":{"OAuth2":{"flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://api.roaring.io/token"}},"type":"oauth2"}}},"info":{"description":"Company Search enables searching for a specific company or a selection of companies based on free text and variables such as, geography, company type, number of employees etc. perfect for creating prospect list for example.\nThe Company Search API lets you find specific companies or create targeted company lists using free text or search filters like geography, company type, and number of employees — perfect for prospecting, onboarding, or market analysis.\nYou can also use the fuzzy search query parameter for performing searches that are less targeted to a specific name or allowing a mistake when searching for a company name in free text. \n\nWith this API you can:\n\n- Find individual companies\n- Build prospect lists based on filters like location, size, and business type\n- Search in our sandbox environment using test companies\n\n**Note:**\n\nUsing placeholder company IDs keeps the service free of charge. (Learn more here https://help.roaring.io/en/articles/154766-company-search.)\n\n**Use case:**\n\nA financial institution onboarding a new B2B customer uses the Company Search API to quickly identify and shortlist potential business customers in a specific region and employee size range, helping sales teams prioritize outreach and onboarding efforts.\n\n\n","title":"Company Search","version":"2.1","x-logo":{"url":"https://assets.roaring.io/svg/company-search-v3.1.svg"}},"openapi":"3.0.1","paths":{"/search":{"get":{"description":"Search companies matching query string parameters.\n\n### Sandbox examples\nIn order to test the service, please use the following values in the Sandbox environment:\n\n| Description | URL |\n| - | - |\n| search by freetext \u0026 fuzzy | [/se/company/search/2.1/search?freeText=contsruction\u0026fuzzy=true](#L3NlL2NvbXBhbnkvc2VhcmNoLzIuMS9zZWFyY2g_ZnJlZVRleHQ9Y29udHNydWN0aW9uJmZ1enp5PXRydWU=) |\n| search by county | [/se/company/search/2.1/search?county=stockholm](#L3NlL2NvbXBhbnkvc2VhcmNoLzIuMS9zZWFyY2g_Y291bnR5PXN0b2NraG9sbQ==) |\n| search by freetext (\"construction\") | [/se/company/search/2.1/search?freeText=construction](#L3NlL2NvbXBhbnkvc2VhcmNoLzIuMS9zZWFyY2g_ZnJlZVRleHQ9Y29uc3RydWN0aW9u) |\n| search by freetext - historical name | [/se/company/search/2.1/search?freeText=Ulfs Kaffemekaniska AB](#L3NlL2NvbXBhbnkvc2VhcmNoLzIuMS9zZWFyY2g_ZnJlZVRleHQ9VWxmcyBLYWZmZW1la2FuaXNrYSBBQg==) |\n","operationId":"search","parameters":[{"description":"Used when paging in a previous searched result","in":"query","name":"requestKey","schema":{"type":"string"}},{"description":"Number of results to return per pagination page","in":"query","name":"pageSize","schema":{"format":"int32","type":"integer"}},{"description":"first result to return from the resultset that is being paged through","in":"query","name":"from","schema":{"format":"int32","type":"integer"}},{"description":"Company address","explode":true,"in":"query","name":"address","schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Company name or company id to search for","in":"query","name":"freeText","schema":{"type":"string"}},{"description":"The date the company searched for should have been registered, range input with : between is accepted","in":"query","name":"companyRegistrationDate","schema":{"type":"string"}},{"description":"County the searched for company should be registered in","in":"query","name":"county","schema":{"type":"string"}},{"description":"The primary industry code the company to search for belongs to","explode":true,"in":"query","name":"industryCode","schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"The legal group code for the type of company to search for","explode":true,"in":"query","name":"legalGroupCode","schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"The legal group text for the type of company to search for","explode":true,"in":"query","name":"legalGroupText","schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Employees interval","explode":true,"in":"query","name":"numberEmployeesInterval","schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Status code that the searched for company should be referenced as","explode":true,"in":"query","name":"statusCode","schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Town the searched for company should be registered in","explode":true,"in":"query","name":"town","schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Vat registered","in":"query","name":"vatReg","schema":{"type":"boolean"}},{"description":"Zip code the searched for company should be registered in","explode":true,"in":"query","name":"zipCode","schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Net operating income, range type, tkr","in":"query","name":"plNetOperatingIncome","schema":{"format":"int64","type":"integer"}},{"description":"Include inactive companies when true; false by default.","in":"query","name":"showInactiveCompanies","schema":{"type":"boolean"}},{"description":"Enable fuzzy matching when true; false by default. Must be supplied once with value true or false.","in":"query","name":"fuzzy","schema":{"type":"boolean"}},{"description":"Requires fuzzy=true. 0, 1 or 2 (default by term length: 1-4 = 0, 5-8 = 1, 9+ = 2)","in":"query","name":"fuzzyDistance","schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanySearchResult"}}},"description":"OK, successful response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":"Returned when something is wrong in the request, e.g. failed argument validation or arguments are missing"},"404":{"description":"Requested resource could not be found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"}}},"description":"An internal server error occurred, please contact the system administrator with information on the error"}},"summary":"Search companies","tags":["CompanySearch"],"x-code-samples":[{"lang":"Shell","source":"curl -X GET --header 'Accept: application/json'\\\n--header 'Authorization: Bearer {ACCESS TOKEN}'\\\n'https://api.roaring.io/se/company/search/2.1/search'"}]}}},"security":[{"OAuth2":[]}],"servers":[{"url":"https://api.roaring.io/se/company/search/2.1"}],"x-category":"company","x-countries":["se"],"x-id":"CompanySearch"}