Units

Create Unit

Create a unit on your account

POST https://api.zenstrin.com/units

Request Body

Name	Type	Description
name*	string	The name of the unit
property*	string	The ID of the property this unit will be assigned to
beds	integer	The number of bedrooms in the unit
baths	integer	The number of baths in the unit
size	integer	The square size of the unit in metres
leasePrice	integer	The lease or rent price for the unit
salePrice	integer	The sale price of the unit
amenities	array	An array of amenities provided in the property. Each amenity is a string
id	string	The ID of the unit. The id parameter represents the unique identifier of a document in the database. Must be a non-empty string. Must not contain any of the following characters: '/', '.', '*', '[', ']', '(', ')'. Must be less than or equal to 1,500 bytes when UTF-8 encoded.
address	string	The address of the unit

200 Ok

List Units

List units from your account

GET https://api.zenstrin.com/units

Query Parameters

Name	Type	Description
filter	String	The item to filter the results with. Available filters include: ["property", "owner"]
filterId	String	The ID of the filtered item

200: OK Ok

Fetch Unit

Get the details of a unit on your account

GET https://api.zenstrin.com/units/:unitId

Path Parameters

Name	Type	Description
unitId*	String	The ID of the unit

200: OK Ok

Update Unit

Update a unit on your account

PATCH https://api.zenstrin.com/units/:unitId

Path Parameters

Name	Type	Description
unitId*	string	The ID of the unit

Request Body

Name	Type	Description
name	string	The name of the unit
beds	integer	The number of bedrooms in the unit
baths	integer	The number of baths in the unit
amenities	array	An array of amenities provided in the property. Each amenity is a string
size	integer	The square size of the unit in metres
salePrice	integer	The sale price of the unit
leasePrice	integer	The lease or rent price for the unit
address	string	The address of the unit

200: OK Ok

List Unit Availability

List available range of dates the unit is available

GET https://api.zenstrin.com/units/:unitId/availability

Returns an array of objects with a checkIn and checkOut date. The unit is available on any period that falls within on the ranges. Available ranges are returned up to 1 year from the date the values are fetched.

Path Parameters

Name	Type	Description
unitId	string	The ID of the unit

200: OK