List all units
curl --request GET \
--url https://api.yorlet.com/v1/units \
--header 'Authorization: <api-key>'{
"count": 1,
"has_more": false,
"object": "list",
"data": [
{
"id": "<string>",
"created": 123,
"object": "unit",
"active": true,
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"country": "<string>",
"postal_code": "<string>",
"state": "<string>"
},
"available_from": 123,
"bathrooms": 123,
"bedrooms": 123,
"building": {
"id": "<string>",
"created": 123,
"object": "building",
"active": true,
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"country": "<string>",
"postal_code": "<string>",
"state": "<string>"
},
"currency": "<string>",
"description": "<string>",
"marketing": {
"featured_photo": "<string>",
"photos": [
"<string>"
]
},
"name": "<string>",
"removable": true,
"single_unit": true,
"unit_fees": {
"management_fee": 123,
"management_fee_amount": 123,
"management_fee_discount": {
"end": 123,
"percent_off": 123
},
"renewal_fee": 123,
"rent_review_fee": 123,
"tax": 123,
"tenant_find_fee": 123,
"updated_at": 123
},
"account": "<string>",
"deleted": false,
"metadata": {}
},
"completion_date": 123,
"contract_address": "<string>",
"currency": "<string>",
"currency_options": {},
"default_deposit": 123,
"default_price": 123,
"default_rent_tax_rate": {
"id": "<string>",
"created": 123,
"object": "tax_rate",
"active": true,
"country": "<string>",
"description": "<string>",
"inclusive": true,
"jurisdiction": "<string>",
"name": "<string>",
"percentage": 123,
"state": "<string>",
"account": "<string>",
"deleted": false
},
"fees": {
"management_fee": 123,
"management_fee_amount": 123,
"management_fee_discount": {
"end": 123,
"percent_off": 123
},
"renewal_fee": 123,
"rent_review_fee": 123,
"tax": 123,
"tenant_find_fee": 123,
"updated_at": 123
},
"furnished": true,
"floor": 123,
"has_owner": true,
"maintenance_threshold": 123,
"name": "<string>",
"plot_number": "<string>",
"square_foot": 123,
"account": "<string>",
"deleted": false,
"archived": true,
"archived_at": 123,
"assignee": "<string>",
"features": {
"balcony": true,
"pet_friendly": true,
"view": "<string>",
"min_term": "<string>"
},
"compliance": {
"epc": "<string>",
"epc_expires_at": 123,
"electric_safety": "<string>",
"electric_safety_expires_at": 123,
"gas_safety": "<string>",
"gas_safety_expires_at": 123,
"gas_safety_required": true
},
"metadata": {},
"offline_reason": "<string>",
"reference": "<string>",
"rent": {
"default": 123,
"maximum": 123,
"minimum": 123,
"tax_percent": 123
},
"sales": {
"last_purchase_price": 123
},
"square_metre": 123,
"under_offer": true,
"unit_group": "<string>"
}
]
}Units
List all units
Returns a list of units. The units are returned sorted by creation date, with the most recent units appearing first.
GET
/
v1
/
units
List all units
curl --request GET \
--url https://api.yorlet.com/v1/units \
--header 'Authorization: <api-key>'{
"count": 1,
"has_more": false,
"object": "list",
"data": [
{
"id": "<string>",
"created": 123,
"object": "unit",
"active": true,
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"country": "<string>",
"postal_code": "<string>",
"state": "<string>"
},
"available_from": 123,
"bathrooms": 123,
"bedrooms": 123,
"building": {
"id": "<string>",
"created": 123,
"object": "building",
"active": true,
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"country": "<string>",
"postal_code": "<string>",
"state": "<string>"
},
"currency": "<string>",
"description": "<string>",
"marketing": {
"featured_photo": "<string>",
"photos": [
"<string>"
]
},
"name": "<string>",
"removable": true,
"single_unit": true,
"unit_fees": {
"management_fee": 123,
"management_fee_amount": 123,
"management_fee_discount": {
"end": 123,
"percent_off": 123
},
"renewal_fee": 123,
"rent_review_fee": 123,
"tax": 123,
"tenant_find_fee": 123,
"updated_at": 123
},
"account": "<string>",
"deleted": false,
"metadata": {}
},
"completion_date": 123,
"contract_address": "<string>",
"currency": "<string>",
"currency_options": {},
"default_deposit": 123,
"default_price": 123,
"default_rent_tax_rate": {
"id": "<string>",
"created": 123,
"object": "tax_rate",
"active": true,
"country": "<string>",
"description": "<string>",
"inclusive": true,
"jurisdiction": "<string>",
"name": "<string>",
"percentage": 123,
"state": "<string>",
"account": "<string>",
"deleted": false
},
"fees": {
"management_fee": 123,
"management_fee_amount": 123,
"management_fee_discount": {
"end": 123,
"percent_off": 123
},
"renewal_fee": 123,
"rent_review_fee": 123,
"tax": 123,
"tenant_find_fee": 123,
"updated_at": 123
},
"furnished": true,
"floor": 123,
"has_owner": true,
"maintenance_threshold": 123,
"name": "<string>",
"plot_number": "<string>",
"square_foot": 123,
"account": "<string>",
"deleted": false,
"archived": true,
"archived_at": 123,
"assignee": "<string>",
"features": {
"balcony": true,
"pet_friendly": true,
"view": "<string>",
"min_term": "<string>"
},
"compliance": {
"epc": "<string>",
"epc_expires_at": 123,
"electric_safety": "<string>",
"electric_safety_expires_at": 123,
"gas_safety": "<string>",
"gas_safety_expires_at": 123,
"gas_safety_required": true
},
"metadata": {},
"offline_reason": "<string>",
"reference": "<string>",
"rent": {
"default": 123,
"maximum": 123,
"minimum": 123,
"tax_percent": 123
},
"sales": {
"last_purchase_price": 123
},
"square_metre": 123,
"under_offer": true,
"unit_group": "<string>"
}
]
}Authorizations
API Key authentication. Use "Bearer YOUR_API_KEY".
Response
200 - application/json
A object with a data property that contains an array of units.
Was this page helpful?
⌘I