Get all leads — Propexo

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

Query parameters

order-bystringOptional

Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc

offsetintegerOptional

Can be used for paginating results

limitintegerOptional

A number between 1 and 250 to determine the number of results to return in a single query

x_idstringOptional

The external lead id

x_property_idstringOptional

Deprecated: Use the Propexo property_id instead

location_idstringOptional

The Propexo unique identifier for the location associated with the property. This is the location specified in RentManager

x_unit_idstringOptional

The external unit id

email_1stringOptional

Lead email address

email_2stringOptional

Lead email address alternate

property_idstringOptional

The Propexo property id

integration_idstringOptional

The Propexo integration id

integration_vendorenumOptional

The integration vendor for the lead.

Response

This endpoint returns an object.

metaobject

resultslist of objects

Errors

1 curl https://api.propexo.com/v1/leads/ \ 2 -H "Authorization: Bearer <token>"

1 { 2 "meta": { 3 "orderBy": [ 4 {} 5 ], 6 "offset": 42, 7 "limit": 42, 8 "hasMore": true, 9 "total": 42 10 }, 11 "results": [ 12 { 13 "id": "sample_value", 14 "created_at": "2024-07-01T00:00:00.000Z", 15 "updated_at": "2024-07-01T00:00:00.000Z", 16 "x_id": "sample_value", 17 "x_property_id": "sample_value", 18 "property_id": "sample_value", 19 "integration_id": "sample_value", 20 "integration_vendor": "sample_value", 21 "screenings": [ 22 { 23 "id": "sample_value", 24 "created_at": "2024-07-01T00:00:00.000Z", 25 "last_seen": "2024-07-01T00:00:00.000Z", 26 "x_id": "sample_value", 27 "status_raw": "sample_value", 28 "screening_date": "2024-07-01T00:00:00.000Z" 29 } 30 ], 31 "last_seen": "2024-07-01T00:00:00.000Z", 32 "x_created_at": "2024-07-01T00:00:00.000Z", 33 "x_guestcard_id": "sample_value", 34 "x_leasing_agent_id": "sample_value", 35 "x_unit_id": "sample_value", 36 "x_updated_at": "2024-07-01T00:00:00.000Z", 37 "x_lead_source_id": "sample_value", 38 "address_1": "sample_value", 39 "address_2": "sample_value", 40 "city": "sample_value", 41 "country": "sample_value", 42 "date_of_birth": "2024-07-01T00:00:00.000Z", 43 "desired_amenities": "sample_value", 44 "desired_floor_plan_id": "sample_value", 45 "desired_floor_plan_name": "sample_value", 46 "desired_lease_term_in_months": "sample_value", 47 "desired_max_rent_in_cents": 1.1, 48 "desired_max_square_ft": 42, 49 "desired_min_rent_in_cents": 1.1, 50 "desired_min_square_ft": 42, 51 "desired_num_bathrooms": 42, 52 "desired_num_bedrooms": 42, 53 "desired_unit_number": "sample_value", 54 "desired_unit_type": "sample_value", 55 "email_1": "sample_value", 56 "email_2": "sample_value", 57 "first_name": "sample_value", 58 "ils": "sample_value", 59 "last_name": "sample_value", 60 "lead_source": "sample_value", 61 "leasing_agent": "sample_value", 62 "middle_name": "sample_value", 63 "notes": "sample_value", 64 "number_of_occupants": 42, 65 "pet_details": "sample_value", 66 "phone_1_type": "sample_value", 67 "phone_1": "sample_value", 68 "phone_2_type": "sample_value", 69 "phone_2": "sample_value", 70 "state": "sample_value", 71 "status": "sample_value", 72 "target_move_in_date": "2024-07-01T00:00:00.000Z", 73 "zip": "sample_value" 74 } 75 ] 76 }

1	curl https://api.propexo.com/v1/leads/ \
2	-H "Authorization: Bearer <token>"

1	{
2	"meta": {
3	"orderBy": [
4	{}
5	],
6	"offset": 42,
7	"limit": 42,
8	"hasMore": true,
9	"total": 42
10	},
11	"results": [
12	{
13	"id": "sample_value",
14	"created_at": "2024-07-01T00:00:00.000Z",
15	"updated_at": "2024-07-01T00:00:00.000Z",
16	"x_id": "sample_value",
17	"x_property_id": "sample_value",
18	"property_id": "sample_value",
19	"integration_id": "sample_value",
20	"integration_vendor": "sample_value",
21	"screenings": [
22	{
23	"id": "sample_value",
24	"created_at": "2024-07-01T00:00:00.000Z",
25	"last_seen": "2024-07-01T00:00:00.000Z",
26	"x_id": "sample_value",
27	"status_raw": "sample_value",
28	"screening_date": "2024-07-01T00:00:00.000Z"
29	}
30	],
31	"last_seen": "2024-07-01T00:00:00.000Z",
32	"x_created_at": "2024-07-01T00:00:00.000Z",
33	"x_guestcard_id": "sample_value",
34	"x_leasing_agent_id": "sample_value",
35	"x_unit_id": "sample_value",
36	"x_updated_at": "2024-07-01T00:00:00.000Z",
37	"x_lead_source_id": "sample_value",
38	"address_1": "sample_value",
39	"address_2": "sample_value",
40	"city": "sample_value",
41	"country": "sample_value",
42	"date_of_birth": "2024-07-01T00:00:00.000Z",
43	"desired_amenities": "sample_value",
44	"desired_floor_plan_id": "sample_value",
45	"desired_floor_plan_name": "sample_value",
46	"desired_lease_term_in_months": "sample_value",
47	"desired_max_rent_in_cents": 1.1,
48	"desired_max_square_ft": 42,
49	"desired_min_rent_in_cents": 1.1,
50	"desired_min_square_ft": 42,
51	"desired_num_bathrooms": 42,
52	"desired_num_bedrooms": 42,
53	"desired_unit_number": "sample_value",
54	"desired_unit_type": "sample_value",
55	"email_1": "sample_value",
56	"email_2": "sample_value",
57	"first_name": "sample_value",
58	"ils": "sample_value",
59	"last_name": "sample_value",
60	"lead_source": "sample_value",
61	"leasing_agent": "sample_value",
62	"middle_name": "sample_value",
63	"notes": "sample_value",
64	"number_of_occupants": 42,
65	"pet_details": "sample_value",
66	"phone_1_type": "sample_value",
67	"phone_1": "sample_value",
68	"phone_2_type": "sample_value",
69	"phone_2": "sample_value",
70	"state": "sample_value",
71	"status": "sample_value",
72	"target_move_in_date": "2024-07-01T00:00:00.000Z",
73	"zip": "sample_value"
74	}
75	]
76	}