Properties API Reference
API Reference/Properties

Properties

For authentication instructions, see API overview.

Endpoints

get/api/v2/properties
post/api/v2/properties
get/api/v2/properties/:id
patch/api/v2/properties/:id
delete/api/v2/properties/:id
get

List all properties

Returns a list of properties. The properties are returned in sorted order, with the most recent appearing first.

Query parameters

  • limitinteger

    The number of records to return

  • pageinteger

    The page number

  • orderstring

    The order of the records

  • sortBystring

    The sort of the records

  • fieldsstring

    The filter of the records

  • pstring

    policyFilters

  • qstring

    search query

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/properties

Response

No response schema
post

Create property

Create property. You need to pass through any required fields, and you can optionally pass through other fields.

Request body

  • namestring
  • typestring
  • addressobject
  • locationstring
  • pricenumber
  • surfacenumber
  • expensenumber
  • priceBasenumber
  • realmIdstring

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X POST -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/properties \
	-d 'name="property1"' \
	-d 'type="type1"' \
	-d 'address="object"' \
	-d 'location="string"' \
	-d 'price=1000' \
	-d 'surface=100' \
	-d 'expense=100' \
	-d 'priceBase=100' \
	-d 'realmId="609a8f85c2834915d0a5a5e8"'

Response

No response schema
get

Retrieve property

Returns a single propert, which you can request by passing through an id in the url.

Path parameters

  • idstring

    ID of the property

Request

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

Response

No response schema
patch

Update property soft

Update property soft by setting the values of the parameters passed. Any parameters not set will be unchanged.

Path parameters

  • idstring

    ID of the property

Request body

  • namestring
  • typestring
  • addressobject
  • locationstring
  • pricenumber
  • surfacenumber
  • expensenumber
  • priceBasenumber
  • realmIdstring

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/properties/:id \
	-d 'name="property1"' \
	-d 'type="type1"' \
	-d 'address="object"' \
	-d 'location="string"' \
	-d 'price=1000' \
	-d 'surface=100' \
	-d 'expense=100' \
	-d 'priceBase=100' \
	-d 'realmId="609a8f85c2834915d0a5a5e8"'

Response

No response schema
delete

Delete property

Path parameters

  • idstring

    ID of the property

Request

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

Response

No response schema