Skip to main content
GET
/
v1
/
applications
List all applications
curl --request GET \
  --url https://api.yorlet.com/v1/applications \
  --header 'Authorization: <api-key>'
{
  "count": 1,
  "has_more": false,
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "created": 123,
      "object": "application",
      "advance_rent_amount": 123,
      "application_configuration": "<string>",
      "application_mode": "classic",
      "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,
      "end_behavior": "roll",
      "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": 123,
        "description": "<string>"
      },
      "rent_term": "<string>",
      "start_date": 123,
      "status": "<string>",
      "subscription_data": {
        "collection_method": "charge_automatically",
        "interval": "month",
        "add_invoice_items": [
          {
            "amount": 123,
            "currency": "<string>",
            "description": "<string>",
            "tax_percent": 50,
            "transfer_behavior": "automatic",
            "type": "charge",
            "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
        },
        "first_invoice_creation": "immediately",
        "interval_count": 123,
        "items": [
          {
            "price_data": {
              "amount": 123,
              "currency": "<string>",
              "tax_percent": 123
            },
            "type": "charge",
            "description": "<string>",
            "metadata": {},
            "price": "<string>",
            "proration_behavior": "create_prorations",
            "schedule": [
              {
                "amount": 123,
                "effective_at": 123
              }
            ],
            "tax_rate": "<string>",
            "transfer_behavior": "automatic",
            "transfer_destination": "<string>",
            "unit": "<string>"
          }
        ],
        "phases": [
          {
            "start_date": 123,
            "items": [
              {
                "price_data": {
                  "amount": 123,
                  "currency": "<string>",
                  "tax_percent": 123
                },
                "type": "charge",
                "description": "<string>",
                "metadata": {},
                "price": "<string>",
                "proration_behavior": "create_prorations",
                "schedule": [
                  {
                    "amount": 123,
                    "effective_at": 123
                  }
                ],
                "tax_rate": "<string>",
                "transfer_behavior": "automatic",
                "transfer_destination": "<string>",
                "unit": "<string>"
              }
            ]
          }
        ],
        "start_date": 123,
        "start_date_config": {
          "day": 16,
          "month": 6,
          "year": 123
        }
      },
      "type": "active_tenancy",
      "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>"
            },
            "account": "<string>",
            "deleted": false,
            "pets": [
              {
                "age": 123,
                "name": "<string>",
                "type": "dog"
              }
            ],
            "pre_qualification": {
              "affordability": {
                "company_name": "<string>",
                "gross_annual_salary": 123,
                "role": "<string>"
              },
              "nationality": "<string>"
            }
          }
        ]
      },
      "metadata": {},
      "steps": [
        {
          "id": "<string>",
          "status": "<string>",
          "type": "<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 applications.

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