Allows clients to filter projects by estimated completion date using one or more UNIX timestamp ranges in UTC. Each range is defined as date_from-date_to, where both boundaries are UNIX timestamps in seconds. Multiple ranges can be provided, separated by commas. A project is included if its completion date falls into at least one of the specified ranges.This parameter is useful when the consumer needs precise time-based filtering (for example, 'all projects with completion date between 1 Jan 2028 and 30 Jun 2028') without relying on textual quarters or year-only filters.

Filters projects by declared completion quarter (as used in the project metadata, e.g. '2026-Q1'). Unlike completion_date_ranges, which uses precise timestamps, this parameter works on a higher-level categorical label (year + quarter). It is typically used when the client wants to show inventory grouped by delivery periods (e.g. all projects completing in Q2 2028 or Q3 2028). Multiple quarters can be passed at once to broaden the selection.

Filters the project list by country name. When this parameter is provided, only projects located in the specified country are returned. The value must match one of the country names returned by the Countries endpoint (for example, 'United Arab Emirates', 'Cyprus', 'Indonesia', 'Oman', 'Thailand'). This parameter is typically used together with regional filters (such as region or districts) to narrow the search to a specific market.

Filters the project list by one or several districts. This parameter lets the client restrict results to specific subareas (for example, particular neighborhoods within a city or emirate). Multiple districts can be provided in a single request so that projects belonging to any of the specified districts are included. This is especially useful for map-based search and location-focused pages.

Specifies the measurement unit used for area values in the /projects list response (area_unit, min_size, max_size).

Specifies the currency in which project prices (min_price, max_price, and price_currency) are returned by the endpoint. The parameter does not change which projects are selected; it changes only the currency and numeric values of prices in the response.

Specifies how the project price range filter should be interpreted in combination with unit_price_from and unit_price_to. When set to unit, the API treats the price range as the total price of a unit (e.g. full apartment or villa). When set to area, the API treats the price range as price per area unit (e.g. per square foot or per square meter, depending on preferred_area_unit). This allows clients to search either by total ticket size or by price per square unit, using the same numeric range parameters.

Allows filtering the project list by explicitly specifying one or multiple project identifiers. This parameter is useful when the client already knows the IDs of target projects (e.g., from saved lists, search indices, or external systems) and wants to retrieve only those entries. The parameter accepts a comma-separated list of numeric IDs. If any of the IDs do not exist or do not match published projects, they are ignored. If none of the provided IDs are valid, the API returns an empty result set. The filter operates independently of other parameters and can be combined with additional filters (e.g., country, region, sale_status), though the result will include only projects matching all applied conditions.

Filters projects by the region in which they are located. The parameter accepts a text value matching one of the region names published by the /clients/regions endpoint. Filtering is case-insensitive but must match the canonical string value. If a region is provided that does not exist in the system, the API returns an empty result set. This filter is commonly used to limit results within major administrative divisions such as Dubai Emirate or Abu Dhabi Emirate. The region filter can be combined with other geographical parameters such as country, districts, and bounding box filters.

Filters the projects list by the current sale status. The parameter accepts snake_case option of parameter(for example, on_sale, out_of_stock). Returned project objects always use snake_case in the sale_status field.

Search by project name, developer name or area name (case insensitive, substring)

Filters the projects list by construction status. The parameter accepts snake_case option.

Filters the project list based on the number of bedrooms available in the units of each project(in comma-separated format). A project appears in the result set if any of its units (including entries in typical_units) has a bedroom count matching one of the values specified in unit_bedrooms.

Filters the projects list by the types of units available in each project. The parameter accepts a single unit type value per request, using one of the values returned by the unit types metadata endpoint GET /api/v2/clients/units/types.

Custom token for client authentication.

Generated from available response content types