Skip to main content
POST
/suumo/companies/search

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
pref
enum<string>
required
Available options:
tokyo,
kanagawa,
osaka,
saitama,
chiba,
aichi,
hyogo,
fukuoka,
hokkaido,
kyoto
station
string
required
Minimum string length: 1
count
integer
required
Required range: x >= 1
timeout
integer
default:300
Required range: 20 <= x <= 1500
line
string | null
Minimum string length: 1
access
enum<string>[] | null
Available options:
open_late,
near_station,
open_year_round,
parking,
car_pickup
staff_features
enum<string>[] | null
Available options:
foreign_language,
female_staff,
consulting_master
services
enum<string>[] | null
Available options:
local_10_years,
multi_store,
kids_service,
barrier_free,
rent_guarantor,
no_guarantor_ok,
move_in_loan,
mover_referral,
management_24h,
handles_sales,
corporate_contracts,
company_housing
media
enum<string>[] | null
Available options:
has_video,
has_coupon,
has_staff_comment
keyword
string | null
sort
enum<string> | null
Available options:
name_asc,
name_desc,
listings_desc,
listings_asc

Response

Successful Response

id
string
required
url
string
required
@type
string
default:SuumoCompanyCard
name
string | null
headline
string | null
listing_count
integer | null
address
string | null
station
string | null
walk
string | null
business_hours
string | null
holidays
string | null
tel
string | null
features
string[]
image
string | null