Get text-based search for companies
get
/token/api/v4/company/find
This endpoint provides text-based, typeahead-style searches for company records. The user is expected to narrow searches down to a desired record, and then use the
The response consists of the following set of fixed attributes:
Id(DaaS Id), Company Name, Trade Style Name, Street Address 1, Street Address 2, City, State Name/ Province, State Abbreviation, Zip Code, Country, Major Industry Category/ Line of Business, Sales Volume (US Dollars)
/v4/company/retrieve
endpoint to obtain it in full.
Cost:There is no cost or increase of usage count for this action.
As input, define the query parameterorgNameAddress
, with a value of whatever the user has entered so far. This could be parts from the name of the company, address line, state, country or zip code. The second mandatory input parameter is
Key
which is the API access key obtained from the
/v4/company/preparefind
endpoint.
The response consists of the following set of fixed attributes:
Id(DaaS Id), Company Name, Trade Style Name, Street Address 1, Street Address 2, City, State Name/ Province, State Abbreviation, Zip Code, Country, Major Industry Category/ Line of Business, Sales Volume (US Dollars)
Versions Supported:
v4
Request
Query Parameters
-
City: string
Mandatory. The list of cities to boost the results on
-
Countries: string
Optional. The list of countries to boost the results on
-
Key: string
Mandatory. The access token for this api.
-
State: string
Optional. The list of states to boost the results on
-
limit: integer
Optional. The expected number records in the response
-
orgNameAddress: string
Mandatory. The text entered by the user
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
Success
Root Schema : schema
Type:
array
500 Response
An unexpected error occurred during the request.
Root Schema : schema
Type:
object
Examples
Example Request:
/token/api/v4/company/find?orgNameAddress=Oracle Redwood&Key=WG2J41MPZLCSL4VOH92
Example Response:
{ "party": [ {"info_organization_name": "Oracle Corporation", "name_tradename": "Oracle", "location_address1": "500 Oracle Pkwy", "location_city": "Redwood City", "location_full_state": "California", "location_state": "CA", "location_postal_code: "940651675", "location_country": "USA", "id",: "BE0NDcwOTE5PywxASF=", "company_sales_volume": "38275000000", "company_maj_ind_cg": "7" } ] }Back to Top