Skip to main content
GET
/
v1
/
leads
/
enquiries
/
{id}
Retrieve an enquiry
curl --request GET \
  --url https://api.yorlet.com/v1/leads/enquiries/{id} \
  --header 'Authorization: <api-key>'
{
  "id": "<string>",
  "created": 123,
  "object": "leads.enquiry",
  "email": "<string>",
  "name": "<string>",
  "phone": "<string>",
  "qualification_configuration": {
    "id": "<string>",
    "created": 123,
    "object": "leads.qualification_configuration",
    "active": true,
    "after_completion": {
      "hosted_confirmation": {
        "custom_message": "<string>"
      },
      "redirect": {
        "url": "<string>"
      }
    },
    "default": true,
    "description": "<string>",
    "hosted_qualification_url": "<string>",
    "name": "<string>",
    "questions": {
      "move_in_date": {
        "enabled": true,
        "required": false
      },
      "budget": {
        "enabled": true,
        "required": false,
        "min_budget": null,
        "max_budget": null
      },
      "household": {
        "enabled": true,
        "required": false,
        "ask_occupants": true,
        "ask_children": false,
        "max_occupants": null
      },
      "pets": {
        "enabled": true,
        "required": false,
        "allowed": true,
        "allowed_types": null,
        "max_pets": null
      },
      "employment": {
        "enabled": true,
        "required": false,
        "ask_employer": false,
        "ask_income": false,
        "accepted_statuses": [
          "employed",
          "self_employed",
          "student",
          "retired",
          "benefits",
          "other"
        ]
      },
      "smoking": {
        "enabled": false,
        "required": false,
        "non_smokers_only": false
      },
      "current_situation": {
        "enabled": false,
        "required": false,
        "ask_reason_for_moving": false,
        "ask_current_landlord": false
      },
      "right_to_rent": {
        "enabled": false,
        "required": false
      },
      "guarantor": {
        "enabled": false,
        "required": false
      }
    },
    "custom_questions": [
      {
        "id": "<string>",
        "label": "<string>",
        "options": [
          "<string>"
        ],
        "required": false
      }
    ],
    "account": "<string>",
    "deleted": false,
    "metadata": {}
  },
  "qualification": {
    "answers": {
      "budget": 123,
      "household_occupants": 123,
      "household_has_children": true,
      "has_pets": true,
      "pet_types": [],
      "pet_details": "<string>",
      "employer_name": "<string>",
      "is_smoker": true,
      "reason_for_moving": "<string>",
      "current_landlord_name": "<string>",
      "current_landlord_contact": "<string>",
      "has_right_to_rent": true,
      "has_guarantor": true
    },
    "custom_answers": [
      {
        "id": "<string>",
        "label": "<string>",
        "value": "<string>"
      }
    ],
    "reason": "<string>",
    "score": 123
  },
  "referral": {
    "ip_address": "<string>",
    "user_agent": "<string>"
  },
  "assignee": {
    "id": "<string>",
    "created": 123,
    "object": "user",
    "email": "<string>",
    "name": "<string>",
    "account": "<string>",
    "deleted": false
  },
  "unit": {
    "id": "<string>",
    "created": 123,
    "object": "unit",
    "active": true,
    "address": {
      "line1": "<string>",
      "line2": "<string>",
      "city": "<string>",
      "country": "<string>",
      "postal_code": "<string>",
      "state": "<string>"
    },
    "available_from": 123,
    "bathrooms": 123,
    "bedrooms": 123,
    "building": {
      "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,
      "unit_fees": {
        "management_fee": 123,
        "management_fee_amount": 123,
        "management_fee_discount": {
          "percent_off": 123,
          "end": 123
        },
        "renewal_fee": 123,
        "rent_review_fee": 123,
        "tax": 123,
        "tenant_find_fee": 123,
        "updated_at": 123
      },
      "account": "<string>",
      "deleted": false,
      "metadata": {}
    },
    "completion_date": 123,
    "contract_address": "<string>",
    "currency": "<string>",
    "currency_options": {},
    "default_deposit": 123,
    "default_price": 123,
    "default_rent_tax_rate": {
      "id": "<string>",
      "created": 123,
      "object": "tax_rate",
      "active": true,
      "country": "<string>",
      "description": "<string>",
      "inclusive": true,
      "jurisdiction": "<string>",
      "name": "<string>",
      "percentage": 123,
      "state": "<string>",
      "account": "<string>",
      "deleted": false,
      "metadata": {}
    },
    "fees": {
      "management_fee": 123,
      "management_fee_amount": 123,
      "management_fee_discount": {
        "percent_off": 123,
        "end": 123
      },
      "renewal_fee": 123,
      "rent_review_fee": 123,
      "tax": 123,
      "tenant_find_fee": 123,
      "updated_at": 123
    },
    "furnished": true,
    "floor": 123,
    "has_owner": true,
    "maintenance_threshold": 123,
    "name": "<string>",
    "plot_number": "<string>",
    "square_foot": 123,
    "account": "<string>",
    "deleted": false,
    "archived": true,
    "archived_at": 123,
    "assignee": "<string>",
    "features": {
      "balcony": true,
      "pet_friendly": true,
      "view": "<string>",
      "min_term": "<string>"
    },
    "compliance": {
      "epc": "<string>",
      "epc_expires_at": 123,
      "electric_safety": "<string>",
      "electric_safety_expires_at": 123,
      "gas_safety": "<string>",
      "gas_safety_expires_at": 123,
      "gas_safety_required": true
    },
    "metadata": {},
    "offline_reason": "<string>",
    "reference": "<string>",
    "rent": {
      "default": 123,
      "maximum": 123,
      "minimum": 123,
      "tax_percent": 123
    },
    "sales": {
      "last_purchase_price": 123
    },
    "square_metre": 123,
    "under_offer": true,
    "unit_group": "<string>"
  },
  "reviewed_at": 123,
  "reviewed_by": "<string>",
  "account": "<string>",
  "deleted": false,
  "metadata": {}
}

Authorizations

​
Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Path Parameters

​
id
string
required

The id identifier.

Response

200 - application/json

Returns an enquiry object if a valid identifier was provided.

​
id
string
required

Unique identifier for the object.

​
created
number
required

Time at which the object was created. Measured in seconds since the Unix epoch.

​
object
enum<string>
required
Available options:
leads.enquiry
​
email
string | null
required

The enquirer's email address.

​
name
string | null
required

The enquirer's full name.

​
phone
string | null
required

The enquirer's phone number.

​
qualification_configuration
required

The qualification configuration the enquiry was submitted against, if any.

​
qualification
object
required

The qualification data captured for this enquiry.

​
referral
object
required

Referral metadata captured when the enquiry was submitted.

​
status
enum<string>
required

The status of the enquiry.

Available options:
new,
pending,
contacted,
qualified,
viewing,
application,
won,
lost,
disqualified
​
source
enum<string> | null
required

The channel the enquiry originated from.

Available options:
web_form,
widget,
email,
portal,
phone,
manual,
referral,
null
​
assignee
required

The team member the enquiry is assigned to.

​
unit
required

The unit the lead has expressed interest in, if any.

​
reviewed_at
number | null
required

Time at which the enquiry was reviewed. Measured in seconds since the Unix epoch.

​
reviewed_by
string | null
required

The ID of the user who reviewed the enquiry.

​
account
string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

​
deleted
boolean
default:false

Only returned if the object has been deleted.

​
metadata
object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.