Skip to main content
GET
/
v1
/
buildings
List all buildings
curl --request GET \
  --url https://api.yorlet.com/v1/buildings \
  --header 'Authorization: <api-key>'
{
  "count": 1,
  "has_more": false,
  "object": "list",
  "data": [
    {
      "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,
      "type": "block_management",
      "unit_fees": {
        "management_fee": 123,
        "management_fee_amount": 123,
        "management_fee_discount": {
          "end": 123,
          "percent_off": 123
        },
        "management_fee_type": "percentage",
        "renewal_fee": 123,
        "tax": 123,
        "tax_behavior": "exclusive",
        "tenant_find_fee": 123,
        "updated_at": 123
      },
      "account": "<string>",
      "deleted": false,
      "metadata": {}
    }
  ]
}

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 buildings.

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