Skip to main content
POST
/importyeti/companies/search

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
keyword
string
required
Minimum string length: 1
count
integer
required
Required range: 1 <= x <= 140
timeout
integer
default:300
Required range: 20 <= x <= 1500
profile_type
enum<string>
default:both
Available options:
both,
company,
supplier
most_recent_shipment
enum<string>
default:any
Available options:
any,
6mo,
12mo
min_shipments
integer | null
Required range: x >= 0

Response

Successful Response

id
string
required
alias
string
required
role
string
required
url
string
required
@type
string
default:ImportyetiProfile
name
string | null
country_code
string | null
address
string | null
total_shipments
integer | null
last_shipment_date
string | null
other_addresses_count
integer | null
other_names_count
integer | null