Skip to main content
GET
/
v1
/
units
List all units
curl --request GET \
  --url https://api.yorlet.com/v1/units \
  --header 'Authorization: <api-key>'
import requests

url = "https://api.yorlet.com/v1/units"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.yorlet.com/v1/units', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.yorlet.com/v1/units",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.yorlet.com/v1/units"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.yorlet.com/v1/units")
  .header("Authorization", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.yorlet.com/v1/units")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "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": {
            "percent_off": 123,
            "end": 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,
        "metadata": {}
      },
      "fees": {
        "management_fee": 123,
        "management_fee_amount": 123,
        "management_fee_discount": {
          "percent_off": 123,
          "end": 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

Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Response

200 - application/json

A object with a data property that contains an array of units.

count
number
required

Total number of items in the list.

Example:

1

has_more
boolean
required

Whether more items are available.

Example:

false

object
enum<string>
required
Available options:
list
data
object[]
required