Qodex.ai

Search companies

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

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
zipCodestringZip code the searched for company should be registered in
zipCodestringZip code the searched for company should be registered in
domicileCodestringDomicile code the searched for company should be registered in
domicileCodestringDomicile code the searched for company should be registered in
domicileTextstringDomicile text the searched for company should be registered in
domicileTextstringDomicile text 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
legalGroupTextstringThe legal group text for the type of company to search for
statusCodestringStatus code that the searched for company should be referenced as
companyRegistrationDatestringThe date the company searched for should have been registered, range input with : between is accepted
freeTextstringSearch by either company name or company id

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":{"domicileCode":"\u003cobject\u003e","domicileText":"\u003cobject\u003e","industryCode":"\u003cobject\u003e","legalGroupCode":"\u003cobject\u003e","legalGroupText":"\u003cobject\u003e","postTown":"\u003cobject\u003e","postZipCode":"\u003cobject\u003e","statusCode":"\u003cobject\u003e"},"next":"\u003cstring\u003e","previous":"\u003cstring\u003e","requestKey":"\u003cstring\u003e"}