Project Details
The Project Details endpoint provides complete information about a single project, including its location, pricing, area ranges, statuses, media assets, amenities, payment plans, buildings, and other related data.
This endpoint is intended for retrieving the full structure of a project object using its unique identifier.
The response includes both project-level attributes and nested entities such as floor plans, images, typical units, and location metadata.
Optional query parameters allow adjusting output preferences such as response format, currency, and area units.
Request
GET /api/v2/clients/projects/{id}
Description
Returns full, detailed project information for a specific project ID.
This response includes everything from the list endpoint, plus additional data:
- geographic information (country, region, location)
- pricing ranges
- construction status and sale status
- developer data
- media assets (cover image, galleries)
- typical units
- amenities
- payment plans (if available)
Response Example
{
"id": 128,
"name": "Central Hill Residences",
"country": "UAE", "region": "Dubai",
"status": "Under Construction",
"sale_status": "On Sale",
"min_price": 3556000,
"max_price": 12460000,
"developer": {
"id": 194,
"name": "ABC Developers"
},
"cover_image": {
"url": "https://...", "metadata": { "mime": "image/webp", "size": 24400 } },
"typical_units":
[
{
"bedrooms": 2,
"min_price": 3538000,
"max_price": 4441000,
"unit_type": "apartments"
} ],
"amenities":
[ "Pool", "Gym", "Parking" ], "location": { "id": 301, "name": "Downtown" }}
Typical Use Cases
- Building project detail pages
- Populating UI blocks: developer, amenities, typical units, gallery
- Feeding mobile apps with full project details
- Linking from map or search results to full views
Notes
- This endpoint returns the most complete form of project data.
- Some fields appear only here (not in the list): amenities, gallery, typical units, etc.
- Localization support exists but requires additional clarification in a later section.
Query Parameters
The Project Details endpoint supports several optional query parameters that allow clients to adjust how project data is presented in the response.
These parameters do not filter or modify which project is returned; instead, they influence output format, preferred measurement units, and currency representation.
All parameters are optional, and when omitted, the endpoint returns the project using default settings.
The id path parameter uniquely identifies the project, while additional parameters such as format, preferred_area_unit, preferred_currency, and language allow clients to tailor the presentation of numerical and textual fields to their integration needs.
Each parameter is described in detail in the following sections, including supported values, behavior, example requests, and notes.
language
Description
The language parameter specifies the language used for translatable text fields returned by the Project Details endpoint.
When provided, the API returns all supported translatable text fields in the requested language. If a translation is not available for a specific field, the API falls back to English (en-us) without error.
The parameter affects only the representation of text values in the response. It does not influence which project is returned, or any numeric, media, or structural fields.
Translatable fields
For the Project Details endpoint, the language parameter applies to the following fields:
| Field | Description |
|---|---|
overview | Full project description |
short_description | Short project summary, when available |
project_amenities[].amenity.name | Amenity names |
buildings[].name | Building names |
buildings[].description | Building descriptions, when available |
Note: The following fields are always returned in English or snake_case regardless of
language:construction_status,sale_status,furnishing,buildings[].building_type,payment_plans[].name,payment_plans[].steps[].name.
Supported languages
Available language codes:
GET /api/v2/clients/projects/languages
Confirmed languages with translated content: en-us (default), ar, de, fr, he, hi, it, pl, ru, tr, zh.
Meta
| Field name | Type | Required | Default | Notes |
|---|---|---|---|---|
language | string | No | en-us | Supported values: see GET /api/v2/clients/projects/languages |
Request and Response Examples
Example 1 — German language:
GET /api/v2/clients/projects/3071?language=de
Response (fragment):
json
{
"id": 3071,
"name": "The Edit at d3",
"construction_status": "under_construction",
"sale_status": "presale",
"overview": "Das Edit at d3 von Meraas ist ein architektonisches Wahrzeichen im Dubai Design District d3...", "project_amenities":
[
{ "amenity": { "name": "Coworking-Bereich" } }
],
"buildings":
[ { "name": "Turm A", "description": null },
{ "name": "Turm B", "description": null },
{ "name": "Turm C", "description": null }
]}
Example 2 — French language, project with building descriptions:
GET /api/v2/clients/projects/3335?language=fr
Response (fragment):
json
{
"id": 3335,
"overview": "Faits généraux sur le projet: Bab Al Qasr Seaview Residence 51...", "buildings":
[ { "name": "Bâtiment",
"description": "Appartements de 2, 3, 4 et 5 chambres, duplex..." },
{ "name": "Maisons de ville",
"description": "Maisons de ville avec 5 chambres" }
]}
Example 3 — Default behavior (parameter omitted):
GET /api/v2/clients/projects/3071
Response (fragment):
json
{
"id": 3071,
"overview": "The Edit at d3 by Meraas is an architectural landmark...", "buildings":
[ { "name": "Tower A" }, { "name": "Tower B" }, { "name": "Tower C" } ]}
Notes
- Supported language codes are available at
GET /api/v2/clients/projects/languages. construction_status,sale_status,furnishing, andbuildings[].building_typeare always returned in snake_case English, regardless oflanguage.payment_plans[].nameandpayment_plans[].steps[].nameare always returned in English regardless oflanguage.- Fields without available translations fall back to English silently.
preferred_area_unit
Description
Controls the unit used for area-related fields in the project details response.
The parameter influences:
- Project-level fields:
min_size,max_size. - The
area_unitfield in the response.
Meta
| Field name | Type | Required | Default | Notes |
|---|---|---|---|---|
| preferred_area_unit | string | no | sqft | Affects min_size, max_size and area_unit. |
Request and Response Examples
Default (square feet):
GET /api/v2/clients/projects/1127
{
"id": 1127,
"name": "Muraba Veil",
"min_price": 12576212.013625,
"max_price": 72873192.0085,
"min_size": 3838.0102893381595,
"max_size": 9903.078154476,
"price_currency": "AED",
"area_unit": "sqft",
"typical_units": [
{
"bedrooms": 2,
"from_price_aed": 12576212,
"to_price_aed": 31261488,
"from_price_usd": 3424428,
"to_price_usd": 8512318,
"from_size_sqft": 3838.0,
"to_size_sqft": 4940.0,
"from_size_m2": 356.561714,
"to_size_m2": 458.94082
} ]}
Square meters (converted values):
GET /api/v2/clients/projects/1127?preferred_area_unit=m2
{
"id": 1127,
"name": "Muraba Veil",
"min_price": 12576212.013625,
"max_price": 72873192.0085,
"min_size": 356.55985594,
"max_size": 920.018409,
"price_currency": "AED",
"area_unit": "m2",
"typical_units": [
{
"bedrooms": 2,
"from_price_aed": 12576212,
"to_price_aed": 31261488,
"from_price_usd": 3424428,
"to_price_usd": 8512318,
"from_size_sqft": 3838.0,
"to_size_sqft": 4940.0,
"from_size_m2": 356.561714,
"to_size_m2": 458.94082
} ]}
Example with another value (label only, no numeric change):
GET /api/v2/clients/projects/1127?preferred_area_unit=sqm
{
"id": 1127,
"name": "Muraba Veil",
"min_price": 12576212.013625,
"max_price": 72873192.0085,
"min_size": 3838.0102893381595,
"max_size": 9903.078154476,
"price_currency": "AED", "area_unit": "sqm"}
Notes
- When
preferred_area_unitis omitted,min_sizeandmax_sizeare returned in square feet andarea_unitissqft. - When
preferred_area_unit=m2is used,min_sizeandmax_sizeare returned in square meters andarea_unitism2. - For values other than
sqftandm2, the response uses the provided string inarea_unit, whilemin_sizeandmax_sizeremain in the default unit.
preferred_currency
Description
Controls the currency used for aggregated price fields in the project details response.
The parameter affects:
- Project-level fields:
min_price,max_price. - The
price_currencyfield in the response. - Typical units retain both AED and USD values in their dedicated fields.
Meta
| Field name | Type | Required | Default | Notes |
|---|---|---|---|---|
| preferred_currency | string | no | AED | Affects min_price, max_price, price_currency. |
Request and Response Examples
Default (AED):
GET /api/v2/clients/projects/1127?preferred_currency=AED
{
"id": 1127,
"name": "Muraba Veil",
"min_price": 12576212.013625,
"max_price": 72873192.0085,
"min_size": 3838.0102893381595,
"max_size": 9903.078154476,
"price_currency": "AED",
"area_unit": "sqft",
"typical_units": [
{
"bedrooms": 2,
"from_price_aed": 12576212,
"to_price_aed": 31261488,
"from_price_usd": 3424428,
"to_price_usd": 8512318
} ]}
USD:
GET /api/v2/clients/projects/1127?preferred_currency=USD
{
"id": 1127,
"name": "Muraba Veil",
"min_price": 3424428.05,
"max_price": 19842938.6,
"min_size": 3838.0102893381595,
"max_size": 9903.078154476,
"price_currency": "USD",
"area_unit": "sqft",
"typical_units": [
{
"bedrooms": 2,
"from_price_aed": 12576212,
"to_price_aed": 31261488,
"from_price_usd": 3424428,
"to_price_usd": 8512318
} ]}
Notes
- When
preferred_currencyis omitted, prices are returned in AED andprice_currencyisAED. - When
preferred_currency=USDis provided,min_priceandmax_priceare converted to USD andprice_currencyis set toUSD. - Typical units always expose both AED and USD price fields, regardless of the selected
preferred_currency. - Verified values on this endpoint:
AED,USD.
id
Description
Unique identifier of the project. This is a path parameter and must be provided in every request.
If the project with the specified ID exists and is accessible, the endpoint returns its full details.
Meta
| Field name | Type | Required | Default | Notes |
|---|---|---|---|---|
| id | integer | yes | — | Project identifier in the path. |
Request and Response Examples
GET /api/v2/clients/projects/1127
{
"id": 1127,
"name": "Muraba Veil", "developer": "Muraba Properties", "construction_status": "under_construction",
"sale_status": "out_of_stock",
"min_price": 12576212.013625,
"max_price": 72873192.0085,
"min_size": 3838.0102893381595,
"max_size": 9903.078154476,
"price_currency": "AED",
"area_unit": "sqft"
}
Notes
- The
idparameter is part of the URL path and cannot be omitted. - If the project ID does not exist or is not available for the client, the API returns an error response.
Updated 21 days ago