Skip to main content
POST
Search companies

Authorizations

Authorization
string
header
required

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

Body

application/json
query
string

Which companies to find, in plain language. It is turned into filters, which the page answers with as filters.

Required string length: 1 - 2000
Example:

"logistics companies in Portugal"

filters
object

Filters by name, with values from GET /v1/companies/filters and GET /v1/companies/autocomplete.

Example:
savedSearchId
string

Run a saved company search by its id.

Required string length: 24
Pattern: ^[0-9a-fA-F]+$
savedSearchName
string

Run a saved company search by its title. A title several saved searches share answers 409 saved_search_name_ambiguous.

Required string length: 1 - 255
limit
integer
default:25

Companies per page. The page's most possible cost, limit times $0.0001, is held from your balance first.

Required range: 1 <= x <= 100
cursor
string

The pagination.nextCursor of the page before. Send it with the same search, as the filters the first page answered with.

Required string length: 1 - 4096

Response

One page of companies.

data
object[]
required
pagination
object
required
filters
object
required

The filters the search ran with. Send them with cursor for the next page, or save them as a saved search.

unresolvedCriteria
string[]

With query: the parts of it that could not be turned into a filter.