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

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

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/renewal_intents', 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/renewal_intents",
  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/renewal_intents"

	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/renewal_intents")
  .header("Authorization", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

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

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": "renewal_intent",
      "application": {
        "id": "<string>",
        "created": 123,
        "object": "application",
        "advance_rent_amount": 123,
        "application_configuration": "<string>",
        "assignee": "<string>",
        "building": "<string>",
        "building_snapshot": {
          "name": "<string>",
          "single_unit": true
        },
        "completed_at": 123,
        "contract": "<string>",
        "contract_address": "<string>",
        "contract_options": {
          "automatic_counter_signature": true,
          "legal_entity": "<string>",
          "owner_signature_required": true,
          "send_applicant_email": true,
          "send_owner_completion_email": true
        },
        "contract_template": "<string>",
        "current_step": {
          "id": "<string>",
          "next_step": "<string>",
          "type": "advance_rent"
        },
        "currency": "gbp",
        "deal_assignee": "<string>",
        "deposit_amount": 123,
        "has_owner": true,
        "holding_fee_amount": 123,
        "restrict_credits_to_application": true,
        "end_date": 123,
        "from_application": {
          "action": "revision",
          "application": "<string>"
        },
        "move_in_date": 123,
        "move_out_date": 123,
        "open": true,
        "owner_options": {
          "apply_unit_fees": true
        },
        "partial_payment": {
          "amount": 49999950,
          "description": "<string>"
        },
        "rent_term": "<string>",
        "start_date": 123,
        "status": "<string>",
        "subscription_data": {
          "add_invoice_items": [
            {
              "amount": 123,
              "currency": "<string>",
              "description": "<string>",
              "tax_percent": 50,
              "metadata": {},
              "price": "<string>",
              "tax_rate": "<string>",
              "transfer_destination": "<string>",
              "unit": "<string>"
            }
          ],
          "billing_anchor": 123,
          "billing_anchor_config": {
            "day_of_month": 16
          },
          "coupon": "<string>",
          "custom_fields": [
            {
              "name": "<string>",
              "value": "<string>"
            }
          ],
          "days_before_collection": 3,
          "days_until_due": 1,
          "end_date": 123,
          "end_date_config": {
            "day": 16,
            "month": 6,
            "year": 123
          },
          "interval_count": 123,
          "items": [
            {
              "price_data": {
                "amount": 123,
                "currency": "<string>",
                "tax_percent": 123
              },
              "description": "<string>",
              "metadata": {},
              "price": "<string>",
              "schedule": [
                {
                  "amount": 123,
                  "effective_at": 123,
                  "effective_at_config": {
                    "day": 16,
                    "month": 6,
                    "year": 123
                  }
                }
              ],
              "tax_rate": "<string>",
              "transfer_destination": "<string>",
              "unit": "<string>"
            }
          ],
          "phases": [
            {
              "start_date": 123,
              "items": [
                {
                  "price_data": {
                    "amount": 123,
                    "currency": "<string>",
                    "tax_percent": 123
                  },
                  "description": "<string>",
                  "metadata": {},
                  "price": "<string>",
                  "schedule": [
                    {
                      "amount": 123,
                      "effective_at": 123,
                      "effective_at_config": {
                        "day": 16,
                        "month": 6,
                        "year": 123
                      }
                    }
                  ],
                  "tax_rate": "<string>",
                  "transfer_destination": "<string>",
                  "unit": "<string>"
                }
              ]
            }
          ],
          "start_date": 123,
          "start_date_config": {
            "day": 16,
            "month": 6,
            "year": 123
          }
        },
        "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>"
              }
            }
          ]
        },
        "metadata": {},
        "overrides": {
          "rent_increase": {
            "tenancy_start_at": 123,
            "first_increase_at": 123
          }
        },
        "steps": [
          {
            "id": "<string>",
            "status": "<string>",
            "type": "<string>"
          }
        ]
      },
      "canceled_at": 123,
      "completed_at": 123,
      "source_application": {
        "id": "<string>",
        "created": 123,
        "object": "application",
        "advance_rent_amount": 123,
        "application_configuration": "<string>",
        "assignee": "<string>",
        "building": "<string>",
        "building_snapshot": {
          "name": "<string>",
          "single_unit": true
        },
        "completed_at": 123,
        "contract": "<string>",
        "contract_address": "<string>",
        "contract_options": {
          "automatic_counter_signature": true,
          "legal_entity": "<string>",
          "owner_signature_required": true,
          "send_applicant_email": true,
          "send_owner_completion_email": true
        },
        "contract_template": "<string>",
        "current_step": {
          "id": "<string>",
          "next_step": "<string>",
          "type": "advance_rent"
        },
        "currency": "gbp",
        "deal_assignee": "<string>",
        "deposit_amount": 123,
        "has_owner": true,
        "holding_fee_amount": 123,
        "restrict_credits_to_application": true,
        "end_date": 123,
        "from_application": {
          "action": "revision",
          "application": "<string>"
        },
        "move_in_date": 123,
        "move_out_date": 123,
        "open": true,
        "owner_options": {
          "apply_unit_fees": true
        },
        "partial_payment": {
          "amount": 49999950,
          "description": "<string>"
        },
        "rent_term": "<string>",
        "start_date": 123,
        "status": "<string>",
        "subscription_data": {
          "add_invoice_items": [
            {
              "amount": 123,
              "currency": "<string>",
              "description": "<string>",
              "tax_percent": 50,
              "metadata": {},
              "price": "<string>",
              "tax_rate": "<string>",
              "transfer_destination": "<string>",
              "unit": "<string>"
            }
          ],
          "billing_anchor": 123,
          "billing_anchor_config": {
            "day_of_month": 16
          },
          "coupon": "<string>",
          "custom_fields": [
            {
              "name": "<string>",
              "value": "<string>"
            }
          ],
          "days_before_collection": 3,
          "days_until_due": 1,
          "end_date": 123,
          "end_date_config": {
            "day": 16,
            "month": 6,
            "year": 123
          },
          "interval_count": 123,
          "items": [
            {
              "price_data": {
                "amount": 123,
                "currency": "<string>",
                "tax_percent": 123
              },
              "description": "<string>",
              "metadata": {},
              "price": "<string>",
              "schedule": [
                {
                  "amount": 123,
                  "effective_at": 123,
                  "effective_at_config": {
                    "day": 16,
                    "month": 6,
                    "year": 123
                  }
                }
              ],
              "tax_rate": "<string>",
              "transfer_destination": "<string>",
              "unit": "<string>"
            }
          ],
          "phases": [
            {
              "start_date": 123,
              "items": [
                {
                  "price_data": {
                    "amount": 123,
                    "currency": "<string>",
                    "tax_percent": 123
                  },
                  "description": "<string>",
                  "metadata": {},
                  "price": "<string>",
                  "schedule": [
                    {
                      "amount": 123,
                      "effective_at": 123,
                      "effective_at_config": {
                        "day": 16,
                        "month": 6,
                        "year": 123
                      }
                    }
                  ],
                  "tax_rate": "<string>",
                  "transfer_destination": "<string>",
                  "unit": "<string>"
                }
              ]
            }
          ],
          "start_date": 123,
          "start_date_config": {
            "day": 16,
            "month": 6,
            "year": 123
          }
        },
        "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>"
              }
            }
          ]
        },
        "metadata": {},
        "overrides": {
          "rent_increase": {
            "tenancy_start_at": 123,
            "first_increase_at": 123
          }
        },
        "steps": [
          {
            "id": "<string>",
            "status": "<string>",
            "type": "<string>"
          }
        ]
      },
      "unit": "<string>",
      "account": "<string>",
      "deleted": false,
      "assignee": "<string>",
      "due_at": 123,
      "no_renewal": {
        "end_date": 123,
        "reason": "<string>",
        "reason_description": "<string>",
        "sub_reason": "<string>"
      },
      "renewal": {
        "end_date": 123,
        "start_date": 123
      },
      "rent_increase": {
        "current_rent": 123,
        "proposed_rent": 123,
        "notice_served_at": 123,
        "notice_file": "<string>",
        "notice_file_url": "<string>",
        "effective_date": 123,
        "tribunal_reference": "<string>",
        "tribunal_outcome_rent": 123,
        "tribunal_decided_at": 123,
        "reversed_at": 123
      },
      "overrides": {
        "rent_increase": {
          "tenancy_start_at": 123,
          "last_increase_at": 123,
          "first_increase_at": 123
        }
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Response

200 - application/json

Returns a list of renewal intents.

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