Leads

Get all leads

GET
https://api.propexo.com/v1/leads

Query parameters

order-by
optional string
offset
optional integer
limit
optional integer
x_id
optional string
x_property_id
optional string
location_id
optional string
x_unit_id
optional string
email_1
optional string
email_2
optional string
property_id
optional string
integration_id
optional string
integration_vendor
optional enum

Response

This endpoint return an object.
meta
object
results
list of objects
GET
/v1/leads
curl https://api.propexo.com/v1/leads \
-H "Authorization: Bearer <token>"
Response
{
"meta": {
"orderBy": [
{}
],
"offset": 1,
"limit": 1,
"hasMore": true,
"total": 1
},
"results": [
{
"id": "id",
"created_at": "created_at",
"updated_at": "updated_at",
"x_id": "x_id",
"x_property_id": "x_property_id",
"property_id": "property_id",
"integration_id": "integration_id",
"integration_vendor": "integration_vendor",
"screenings": [
{
"id": "id",
"created_at": "created_at",
"last_seen": "last_seen",
"x_id": "x_id"
}
],
"last_seen": "last_seen",
"x_created_at": "x_created_at",
"x_guestcard_id": "x_guestcard_id",
"x_leasing_agent_id": "x_leasing_agent_id",
"x_unit_id": "x_unit_id",
"x_updated_at": "x_updated_at",
"x_lead_source_id": "x_lead_source_id",
"address_1": "address_1",
"address_2": "address_2",
"city": "city",
"country": "country",
"date_of_birth": "date_of_birth",
"desired_amenities": "desired_amenities",
"desired_floor_plan_id": "desired_floor_plan_id",
"desired_floor_plan_name": "desired_floor_plan_name",
"desired_lease_term_in_months": "desired_lease_term_in_months",
"desired_max_rent_in_cents": 1.1,
"desired_max_square_ft": 1.1,
"desired_min_rent_in_cents": 1.1,
"desired_min_square_ft": 1.1,
"desired_num_bathrooms": 1.1,
"desired_num_bedrooms": 1,
"desired_unit_number": "desired_unit_number",
"desired_unit_type": "desired_unit_type",
"email_1": "email_1",
"email_2": "email_2",
"first_name": "first_name",
"ils": "ils",
"last_name": "last_name",
"lead_source": "lead_source",
"leasing_agent": "leasing_agent",
"middle_name": "middle_name",
"notes": "notes",
"number_of_occupants": 1,
"pet_details": "pet_details",
"phone_1_type": "phone_1_type",
"phone_1": "phone_1",
"phone_2_type": "phone_2_type",
"phone_2": "phone_2",
"state": "state",
"status": "status",
"target_move_in_date": "target_move_in_date",
"zip": "zip"
}
]
}