Leads

Get all leads

GET
Get all leads. Buildium does not support leads via their API.

Query parameters

order-bystringOptional
offsetintegerOptional
limitintegerOptional
x_idstringOptional
x_property_idstringOptional
location_idstringOptional
x_unit_idstringOptional
email_1stringOptional
email_2stringOptional
property_idstringOptional
integration_idstringOptional
integration_vendorenumOptional
The integration vendor for the lead.

Response

This endpoint returns an object
meta
object
results
list of objects
GET
1curl https://api.propexo.com/v1/leads \
2 -H "Authorization: Bearer <token>"
200Retrieved
1{
2 "meta": {
3 "orderBy": [
4 {}
5 ],
6 "offset": 1,
7 "limit": 1,
8 "hasMore": true,
9 "total": 1
10 },
11 "results": [
12 {
13 "id": "clwktsp9v000008l31iv218hn",
14 "created_at": "2024-03-21T15:38:08.337Z",
15 "updated_at": "2024-03-22T10:59:45.119Z",
16 "x_id": "null",
17 "x_property_id": "null",
18 "property_id": "clwi5xiix000008l6ctdgafyh",
19 "integration_id": "clwh5u07w000508me66sfh3um",
20 "integration_vendor": "(PMS ENUM VALUE)",
21 "screenings": [
22 {
23 "id": "id",
24 "created_at": "created_at",
25 "last_seen": "last_seen",
26 "x_id": "x_id"
27 }
28 ],
29 "last_seen": "2024-03-22T10:59:45.119Z",
30 "x_created_at": "null",
31 "x_guestcard_id": "null",
32 "x_leasing_agent_id": "null",
33 "x_unit_id": "null",
34 "x_updated_at": "null",
35 "x_lead_source_id": "null",
36 "address_1": "null",
37 "address_2": "null",
38 "city": "null",
39 "country": "null",
40 "date_of_birth": "null",
41 "desired_amenities": "null",
42 "desired_floor_plan_id": "null",
43 "desired_floor_plan_name": "null",
44 "desired_lease_term_in_months": "null",
45 "desired_max_rent_in_cents": 150000,
46 "desired_max_square_ft": 1.1,
47 "desired_min_rent_in_cents": 120000,
48 "desired_min_square_ft": 1.1,
49 "desired_num_bathrooms": 1,
50 "desired_num_bedrooms": 3,
51 "desired_unit_number": "null",
52 "desired_unit_type": "null",
53 "email_1": "null",
54 "email_2": "null",
55 "first_name": "null",
56 "ils": "ils",
57 "last_name": "null",
58 "lead_source": "null",
59 "leasing_agent": "null",
60 "middle_name": "null",
61 "notes": "null",
62 "number_of_occupants": 2,
63 "pet_details": "null",
64 "phone_1_type": "null",
65 "phone_1": "null",
66 "phone_2_type": "null",
67 "phone_2": "null",
68 "state": "null",
69 "status": "null",
70 "target_move_in_date": "null",
71 "zip": "null"
72 }
73 ]
74}