Skip to main content
POST
/apartmentlist/locations/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: x >= 1
timeout
integer
default:300
Required range: 20 <= x <= 1500

Response

Successful Response

@type
string
default:ApartmentlistLocation
id
integer | null
alias
string | null
location_type
string | null
name
string | null
display_name
string | null
long_name
string | null
population
integer | null
image
string | null
latitude
number | null
longitude
number | null
metro_id
integer | null
county_id
integer | null