Get all leads

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.

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

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

Query parameters

Response

Errors

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

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