Skip to main content
GET
Suggest company filter values

Authorizations

Authorization
string
header
required

An API key from the console, starting ob_live_, sent as Authorization: Bearer <key>.

Query Parameters

field
enum<string>
required

The filter to suggest values for: company names, headquarters places, or states.

Available options:
company,
location,
state
q
string
required

What has been typed so far, two characters or more.

Required string length: 2 - 200
orgType
enum<string>

investor narrows field=company to investors. Only with field=company.

Available options:
investor
countries
string

Only with field=state: comma-separated countries whose states to suggest, as USA or US. Without it, every country's.

Maximum string length: 1000
Pattern: ^[A-Za-z]{2,3}(\s*,\s*[A-Za-z]{2,3})*$
excludedCountries
string

Only with field=state: comma-separated countries whose states to leave out.

Maximum string length: 1000
Pattern: ^[A-Za-z]{2,3}(\s*,\s*[A-Za-z]{2,3})*$

Response

Suggested values for the filter.

field
enum<string>
required
Available options:
company,
location,
state
suggestions
object[]
required