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,
"has_owner": true,
"unit": "<string>",
"unit_snapshot": {
"name": "<string>"
},
"account": "<string>",
"deleted": false,
"applicants": {
"count": 1,
"has_more": false,
"object": "list",
"data": [
{
"id": "<string>",
"created": 123,
"object": "application.applicant",
"application": "<string>",
"advance_rent": {
"amount": 123,
"paid": true,
"paid_off_platform": true,
"transaction": "<string>"
},
"currency": "gbp",
"customer": "<string>",
"deposit": {
"amount": 123,
"paid": true,
"paid_off_platform": true,
"transaction": "<string>"
},
"guarantor": "<string>",
"guarantor_contract": "<string>",
"holding_fee": {
"amount": 123,
"paid": true,
"paid_off_platform": true,
"transaction": "<string>"
},
"lead_tenant": true,
"permitted_occupier": true,
"requirements": {
"guarantor": true
},
"share_of_rent": 123,
"status": "<string>",
"tos_acceptance": {
"date": 123,
"ip": "<string>"
},
"verification_session": "<string>",
"verification_session_required": true,
"account": "<string>",
"deleted": false,
"pets": [
{
"age": 123,
"name": "<string>"
}
],
"pre_qualification": {
"affordability": {
"company_name": "<string>",
"gross_annual_salary": 123,
"role": "<string>"
},
"nationality": "<string>"
}
}
]
},
"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>"
]
}
}
]
}Tenancies
List all tenancies
Returns a list of tenancies. Supports filtering by status, assignee, building, customer, unit, and date range. Tenancies are returned sorted by creation date, with the most recent first.
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,
"has_owner": true,
"unit": "<string>",
"unit_snapshot": {
"name": "<string>"
},
"account": "<string>",
"deleted": false,
"applicants": {
"count": 1,
"has_more": false,
"object": "list",
"data": [
{
"id": "<string>",
"created": 123,
"object": "application.applicant",
"application": "<string>",
"advance_rent": {
"amount": 123,
"paid": true,
"paid_off_platform": true,
"transaction": "<string>"
},
"currency": "gbp",
"customer": "<string>",
"deposit": {
"amount": 123,
"paid": true,
"paid_off_platform": true,
"transaction": "<string>"
},
"guarantor": "<string>",
"guarantor_contract": "<string>",
"holding_fee": {
"amount": 123,
"paid": true,
"paid_off_platform": true,
"transaction": "<string>"
},
"lead_tenant": true,
"permitted_occupier": true,
"requirements": {
"guarantor": true
},
"share_of_rent": 123,
"status": "<string>",
"tos_acceptance": {
"date": 123,
"ip": "<string>"
},
"verification_session": "<string>",
"verification_session_required": true,
"account": "<string>",
"deleted": false,
"pets": [
{
"age": 123,
"name": "<string>"
}
],
"pre_qualification": {
"affordability": {
"company_name": "<string>",
"gross_annual_salary": 123,
"role": "<string>"
},
"nationality": "<string>"
}
}
]
},
"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
API Key authentication. Use "Bearer YOUR_API_KEY".
Was this page helpful?
⌘I