Skip to main content
GET
/
v1
/
tenancies
List all tenancies
curl --request GET \
  --url https://api.yorlet.com/v1/tenancies \
  --header 'Authorization: <api-key>'
{
  "count": 1,
  "has_more": false,
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "created": 123,
      "object": "tenancy",
      "building": "<string>",
      "building_snapshot": {
        "name": "<string>",
        "single_unit": true
      },
      "cancel_at": 123,
      "canceled_at": 123,
      "customers": [
        {
          "id": "<string>",
          "email": "<string>",
          "name": "<string>"
        }
      ],
      "date_end": 123,
      "date_start": 123,
      "unit": "<string>",
      "unit_snapshot": {
        "name": "<string>"
      },
      "account": "<string>",
      "deleted": false,
      "assignee": "<string>",
      "cancel_reason": "<string>",
      "cancel_reason_description": "<string>",
      "contract_address": "<string>",
      "currency": "gbp",
      "customer_emails": [
        "<string>"
      ],
      "deposit": {
        "deposit_total": 123,
        "deposit_per_applicant": 123
      },
      "metadata": {},
      "move_in_date": 123,
      "move_out_date": 123,
      "renewal_intent": "<string>",
      "review": {
        "assignee": "<string>",
        "create_renewal_intent": true,
        "due_at": 123,
        "notification_channels": []
      },
      "subscription_data": {
        "billing_anchor": 123,
        "interval_count": 123,
        "items": [
          "<unknown>"
        ],
        "phases": [
          "<unknown>"
        ]
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Response

200 - application/json

Returns a list of tenancies.

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