Requirement

object

categoryrequired: PropertyCategory
property_typesrequired: array of PropertyType
bhkrequired: array of number
budget_minrequired: Paise or null
Money in paise (₹1 = 100), an exact integer.
budget_maxrequired: Paise or null
Money in paise (₹1 = 100), an exact integer.
area_min_sqftrequired: number or null
area_max_sqftrequired: number or null
area_unit_displayrequired: AreaUnit or null
sqyd is gaj.
locality_idsrequired: array of Id
Opaque record id.
location_textrequired: string or null
possessionrequired: string or null
transaction_typesrequired: array of TransactionType
furnishingrequired: array of Furnishing
facingrequired: array of Facing
floor_preferencerequired: string or null
min_bathroomsrequired: integer or null
parking_requiredrequired: boolean or null
amenity_idsrequired: array of Id
Opaque record id.
vastu_requiredrequired: boolean or null
purposerequired: string or null
loan_requiredrequired: boolean or null
loan_statusrequired: string or null
buy_withinrequired: string or null
move_in_byrequired: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
lease_monthsrequired: integer or null
tenant_profilerequired: string or null
family_sizerequired: integer or null
has_petsrequired: boolean or null
notesrequired: string or null

Example

{
  "category": "residential",
  "property_types": [
    "apartment"
  ],
  "bhk": [
    0
  ],
  "budget_min": 850000000,
  "budget_max": 850000000,
  "area_min_sqft": 0,
  "area_max_sqft": 0,
  "area_unit_display": "sqft",
  "locality_ids": [
    "cmusrceel0000q7kaafxqi1om"
  ],
  "location_text": "string",
  "possession": "string",
  "transaction_types": [
    "new_booking"
  ],
  "furnishing": [
    "unfurnished"
  ],
  "facing": [
    "north"
  ],
  "floor_preference": "string",
  "min_bathrooms": 0,
  "parking_required": true,
  "amenity_ids": [
    "cmusrceel0000q7kaafxqi1om"
  ],
  "vastu_required": true,
  "purpose": "string",
  "loan_required": true,
  "loan_status": "string",
  "buy_within": "string",
  "move_in_by": "2026-10-06",
  "lease_months": 0,
  "tenant_profile": "string",
  "family_size": 0,
  "has_pets": true,
  "notes": "string"
}

{ "category": "residential", "property_types": [ "apartment" ], "bhk": [ 0 ], "budget_min": 850000000, "budget_max": 850000000, "area_min_sqft": 0, "area_max_sqft": 0, "area_unit_display": "sqft", "locality_ids": [ "cmusrceel0000q7kaafxqi1om" ], "location_text": "string", "possession": "string", "transaction_types": [ "new_booking" ], "furnishing": [ "unfurnished" ], "facing": [ "north" ], "floor_preference": "string", "min_bathrooms": 0, "parking_required": true, "amenity_ids": [ "cmusrceel0000q7kaafxqi1om" ], "vastu_required": true, "purpose": "string", "loan_required": true, "loan_status": "string", "buy_within": "string", "move_in_by": "2026-10-06", "lease_months": 0, "tenant_profile": "string", "family_size": 0, "has_pets": true, "notes": "string" }