Units

Units

For instructions on how to authenticate to use this endpoint, see API overview.

This endpoint allows you to retrieve a list of real estate units within a property management system.

It is retained primarily for backward compatibility. Advised for limited use; consider using more current alternatives for unit data retrieval.

For ad-hoc queries or aggregations of unit data, please utilize the Query endpoint instead.

To export comprehensive lists or extensive pages of unit data, refer to our CDP/Batch Exports solutions.

List all units

Response


Request

GET /api/units
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://app.icloud-ready.com/api/units/

Response

RESPONSE
{
  "name": "string",
  "type": "string",
  "location": "string",
  "price": 0,
  "surface": 0,
  "guaranty": 0,
  "city": "string",
  "subProjectId": "string",
  "priceBase": "string",
  "unitImageUrl": "string",
  "unitNameAr": "string",
  "unitLocation": {
    "type": "string",
    "coordinates": [
      0
    ]
  },
  "expense": {
    "name": "string",
    "value": 0
  },
  "startingPrice": 0,
  "maxPrice": 0,
  "unitDesc": "string",
  "unitDescAr": "string",
  "unitShortDesc": "string",
  "unitShortDescAr": "string",
  "gallery": [
    "string"
  ],
  "specs": [
    {
      "featureNumber": 0,
      "featureType": "string",
      "featureImage": "string",
      "featureDesc": "string",
      "featureDescAr": "string",
      "featureTag": "string",
      "active": true
    }
  ],
  "options": [
    {
      "optionNumber": 0,
      "optionName": "string",
      "optionNameAr": "string",
      "area": 0,
      "uom": "string",
      "price": 0,
      "active": true
    }
  ],
  "paymentPlans": [
    {
      "planNumber": 0,
      "planName": "string",
      "planNameAr": "string",
      "planDesc": "string",
      "planDescAr": "string",
      "minPrice": 0,
      "maxPrice": 0,
      "default": true,
      "downPayment": 0,
      "installmentsValue": 0,
      "paymentDetails": "string",
      "active": true
    }
  ],
  "floorsPlan": [
    {
      "floorsNumber": 0,
      "floorName": "string",
      "floorNameAr": "string",
      "floorDesc": "string",
      "floorDescAr": "string",
      "rooms": 0,
      "baths": 0,
      "view": "string",
      "area": 0,
      "uom": "string",
      "price": 0,
      "extras": "string",
      "floorImage": "string"
    }
  ],
  "readings": [
    {
      "service": "string",
      "currentReading": 0,
      "previousReading": 0,
      "cost": 0,
      "readingDate": "string",
      "Notes": "string"
    }
  ]
}

Create units

Request Parameters

  • name
    string
  • type
    string
  • location
    string
  • price
    number
  • surface
    number
  • guaranty
    number
  • city
    string
  • subProjectId
    string
  • priceBase
    string
  • unitImageUrl
    string
  • unitNameAr
    string
  • unitLocation
    object
  • expense
    object
  • startingPrice
    number
  • maxPrice
    number
  • unitDesc
    string
  • unitDescAr
    string
  • unitShortDesc
    string
  • unitShortDescAr
    string
  • gallery
    array
  • specs
    array
  • options
    array
  • paymentPlans
    Click to open
    array
  • floorsPlan
    array
  • readings
    array

Request

POST /api/units
export ICLOUDREADY_API_KEY=[your api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://app.icloud-ready.com/api/units/\
	-d name="string"

Response

No response

Retrieve units

Path Parameters

  • id
    string

    ID of the unit

Request

GET /api/units/:id
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://app.icloud-ready.com/api/units/:id/

Response

No response

Update units

Path Parameters

  • id
    string

    ID of the unit

Request

PUT /api/units/:id
export ICLOUDREADY_API_KEY=[your api key]
curl -X PUT \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://app.icloud-ready.com/api/units/:id/

Response

No response

Delete units

Path Parameters

  • id
    string

    ID of the unit

Request

DELETE /api/units/:id
export ICLOUDREADY_API_KEY=[your api key]
curl  -X DELETE \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://app.icloud-ready.com/api/units/:id/

Response

No response

Questions?

Was this page useful?