← Home
Get Locations
Get Locations
This endpoint lists location to be used in create/update properties endpoints.The Locations API helps you search and find places with location level.You can search by title (for example, "Dubai Marina") or filter step-by-step using location levels.It understands location relationships, so results stay accurate and relevant.The API returns results in pages and supports both English and Arabic.
🔐 Bearer Token: Provide your bearer token in the Authorization header when making requests to protected resources.
Query Parameters
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
| title | string | Optional | The title filter, categori(es) with matching title would be returned. | Jumeirah |
| per_page | string | Optional | The number of results per page. | 10 |
| level_1 | string | Optional | Filter locations with level_1 | UAE |
| level_2 | string | Optional | Filter locations with level_2 | Dubai |
| level_3 | string | Optional | Filter locations with level_3 | Jumeirah |
| level_4 | string | Optional | Filter locations with level_4 | La Mer |
| level_5 | string | Optional | Filter locations with level_5 | Port de La Mer |
| level_6 | string | Optional | Filter locations with level_6 | La Sirene |
| level_7 | string | Optional | Filter locations with level_7 | La Sirene 2 |
| level_8 | string | Optional | Filter locations with level_8 | La Sirene Tower 6 |
Response Schema
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
| data | object | Optional | Represents a geographical location or area (e.g., country, city, community, sub-community) within the property listing hierarchy. | |
| id | integer | Optional | The unique identifier for the location. | 14550 |
| breadcrumb | object | Optional | The hierarchical path of the location from the top level (country) to the most specific area. | |
| coordinates | object | Optional | The geographical coordinates of the location (present only when both latitude and longitude exist). | |
| links | object | Optional | The links to pages. | |
| first | string | Optional | The link to first page. | |
| last | string | Optional | The link to last page. | |
| prev | string | Optional | The link to previous page. | |
| next | string | Optional | The link to next page. | |
| meta | object | Optional | Meta about pagination data. | |
| current_page | integer | Optional | The page you are currently on. | |
| from | integer | Optional | The first page of the paginated results. | |
| path | string | Optional | The path of the current page. | |
| to | integer | Optional | The last page of the paginated results. | |
| total | integer | Optional | The total number of results. |
Responses
200✅
401⚠️
403⚠️
Code Examples
curl --location 'https://api.bayut.com/v1/locations?title=Jumeirah&per_page=10&level_1=UAE&level_2=Dubai&level_3=Jumeirah&level_4=La%20Mer&level_5=Port%20de%20La%20Mer&level_6=La%20Sirene&level_7=La%20Sirene%202&level_8=La%20Sirene%20Tower%206' \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": 5013,
"title": {
"en": "23 Marina",
"ar": "مارينا 23"
},
"breadcrumb": {
"en": [
"UAE",
"Dubai",
"Dubai Marina",
"23 Marina"
],
"ar": [
"الإمارات",
"دبي",
"دبي مارينا",
"مارينا 23"
]
},
"coordinates": {
"latitude": 25.0897673516359,
"longitude": 55.1508039236069
}
}
]
}