Skip to main content
GET
/
v1
/
leads
/
enquiries
List all enquiries
curl --request GET \
  --url https://api.yorlet.com/v1/leads/enquiries \
  --header 'Authorization: <api-key>'
{
  "count": 1,
  "has_more": false,
  "object": "list",
  "data": [
    {
      "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>"
      },
      "account": "<string>",
      "deleted": false,
      "metadata": {}
    }
  ]
}

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 enquiries.

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