Get auto completion

POST /v2/autocomplete/companies

Auto complete the name search

Query parameters

apiToken string Required

application/json

Body Required

name string Required

Beginning of the name or the domain of a company
countryFilters array[string] | null
excludeDomains array[string] | null

Responses

200 application/json

Successful Response
Hide response attribute Show response attribute object
- companies array[object] Required
  
  Array of found companies. Returns empty array if no results
  
  Hide companies attributes Show companies attributes object
  
  domain string Required
  
  Domain of the company, used as a unique identifier
  
  logo string | null
  
  name string | null
404

Not found
422 application/json

Validation Error
Hide response attribute Show response attribute object
- detail array[object]
  
  Hide detail attributes Show detail attributes object
  
  loc array[string | integer] Required
  
  msg string Required
  
  type string Required

POST /v2/autocomplete/companies

curl \
 -X POST https://api.ocean.io/v2/autocomplete/companies?apiToken=string \
 -H "Content-Type: application/json" \
 -d '{"name":"ocea","countryFilters":["dk","se"],"excludeDomains":["ocean.com"]}'

Request examples

{
  "name": "ocea",
  "countryFilters": [
    "dk",
    "se"
  ],
  "excludeDomains": [
    "ocean.com"
  ]
}

Response examples (200)

{
  "companies": [
    {
      "domain": "ocean.io",
      "logo": "https://cdn2.ocean.io/companies-logos-v1/domain.com/020539e284d9318e805301b672ad23047c30818a.png",
      "name": "Ocean"
    }
  ]
}

Response examples (422)

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}