List of available units for a specific project

get

https://api-reelly.up.railway.app/api/v2/clients/projects/{id}/units

This endpoint returns the complete list of units belonging to a specific project, including all available configurations, inventory details, and pricing information. It is designed for client applications that need precise, real-time unit-level data to support search, comparison, and purchasing workflows.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

Query Params

bedrooms

float

Filters units by the number of bedrooms. The parameter accepts a single numeric value (e.g., 2) or multiple comma-separated values (e.g., 0,1.5,3.0).

building

integer

Filters units by building ID within the selected project. Many projects contain multiple buildings (towers or blocks), and this parameter allows clients to request units belonging to a specific building. Also support =null options for units without building.

floor

float

Filters units by their floor level. The parameter accepts a single numeric value or a comma-separated list of values. The API performs exact numeric matching against the stored floor value of each unit.

format

string

enum

Allowed:

layout

integer

Filters units by layout ID. The parameter performs an exact match against the layout.id field of each unit. When a numeric layout ID is provided, only units whose layout object has that id are returned. Also support =null options for units without layout.

limit

integer

Defaults to 20

The limit indicates the maximum number of items to return, and is equivalent to the page_size in other styles. Use ?limit=all for getting all items.

max_price

float

Defines the upper bound for the unit price in the selected project. The value is interpreted in the currency specified by preferred_currency. If preferred_currency is omitted, filtering is performed in AED.

max_size

double

Defines the upper limit for the unit size. The value is interpreted in the area unit specified by preferred_area_unit. If preferred_area_unit is not specified, the unit is assumed to be sqft.

min_price

float

Defines the lower bound for the unit price in the selected project. The value is interpreted in the currency specified by preferred_currency. If preferred_currency is not provided, the filter is evaluated in AED.

min_size

float

Defines the lower limit for the unit size. The value is interpreted in the unit specified by preferred_area_unit. If preferred_area_unit is omitted, the API assumes sqft.

offset

integer

Defaults to 20

The offset indicates the starting position of the query in relation to the complete set of unpaginated items.

ordering

string

Which field to use when ordering the results.

preferred_area_unit

string

enum

Defaults to sqft

Defines the measurement unit used for interpreting size filters (min_size, max_size) and for formatting the size and price_per_area values in the unit response.

Allowed:

preferred_currency

string

enum

Defaults to AED

Defines which currency is used when applying price-based filters (min_price, max_price) and when interpreting the price field in unit responses.

Allowed:

Headers

X-API-Key

string

required

Custom token for client authentication.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Authentication credentials were not provided or are invalid.

403

You do not have permission to perform this action.

404

Not found.

200