Terms

Terms

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

Endpoints

    GET/terms
    POST/terms
    GET/terms/:id
    PUT/terms/:id
    DELETE/terms/:id

    Retrieve undefined

    Request

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

    Response

    No response

    Create undefined

    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 /terms
    export ICLOUDREADY_API_KEY=[your api key]
    curl 
        -H 'Content-Type: application/json'\
        -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
        https://app.icloud-ready.com/terms\
    	-d name="string"

    Response

    No response

    Retrieve undefined

    Path Parameters

    • id
      string

      ID of the terms

    Request

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

    Response

    No response

    Update undefined

    Path Parameters

    • id
      string

      ID of the terms

    Request

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

    Response

    No response

    Delete undefined

    Path Parameters

    • id
      string

      ID of the terms

    Request

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

    Response

    No response

    Questions?

    Was this page useful?