Search companies

Finds companies by a plain-language query, by filters, or by a saved company search: send exactly one.

Returns one page of companies and the filters the search ran with. For the next page, send those filters with the page’s pagination.nextCursor as cursor.

Price: $0.0001 per company returned. Before the search runs, limit times $0.0001 is held from your balance, and what the page does not use is released. A page with nothing on it costs nothing. Scope: search. Read-only keys may call it.

POST /v1/companies/search

Search companies

cURL

curl --request POST \
  --url https://api.outbound.dev/v1/companies/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "logistics companies in Portugal",
  "limit": 25
}
'

200

{
  "data": [
    {
      "preferred_name": "Halden Freight",
      "names": [
        "Halden Freight",
        "Halden Freight Lda"
      ],
      "domains": [
        "haldenfreight.com"
      ],
      "linkedin_primary_slug": "halden-freight",
      "standard_industries": [
        "Transportation and Logistics"
      ],
      "status_consensus": "active",
      "employee_count_consensus": {
        "gte": 201,
        "lte": 500
      }
    }
  ],
  "pagination": {
    "nextCursor": "Y29tcGFueV8y",
    "total": 812
  },
  "filters": {
    "headquartersCountryCode": [
      "PRT"
    ],
    "linkedinIndustries": [
      "Transportation, Logistics, Supply Chain and Storage"
    ]
  }
}

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.

Show child attributes

Example:

{ "headquartersCountryCode": ["PRT"] }

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

200

application/json

One page of companies.

data · object[] · required

Show child attributes

pagination · object · required

Show child attributes

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.