Get all leads

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 "x_unit_id_preferred": [ 19 "x_unit_id_preferred" 20 ], 21 "pets": [ 22 { 23 "id": "id", 24 "created_at": "created_at", 25 "updated_at": "updated_at", 26 "x_id": "x_id", 27 "type": "type" 28 } 29 ], 30 "property_id": "property_id", 31 "unit_id_preferred": [ 32 "unit_id_preferred" 33 ], 34 "integration_id": "integration_id", 35 "integration_vendor": "SAMPLE2", 36 "screenings": [ 37 { 38 "id": "id", 39 "created_at": "created_at", 40 "last_seen": "last_seen", 41 "x_id": "x_id" 42 } 43 ], 44 "last_seen": "last_seen", 45 "x_created_at": "x_created_at", 46 "x_guestcard_id": "x_guestcard_id", 47 "x_leasing_agent_id": "x_leasing_agent_id", 48 "x_updated_at": "x_updated_at", 49 "x_lead_source_id": "x_lead_source_id", 50 "address_1": "address_1", 51 "address_2": "address_2", 52 "city": "city", 53 "country": "country", 54 "date_of_birth": "date_of_birth", 55 "desired_amenities": "desired_amenities", 56 "desired_floor_plan_id": "desired_floor_plan_id", 57 "desired_floor_plan_name": "desired_floor_plan_name", 58 "desired_lease_term_in_months": "desired_lease_term_in_months", 59 "desired_max_rent_in_cents": 1.1, 60 "desired_max_square_ft": 1.1, 61 "desired_min_rent_in_cents": 1.1, 62 "desired_min_square_ft": 1.1, 63 "desired_num_bathrooms": 1.1, 64 "desired_num_bedrooms": 1, 65 "desired_unit_number": "desired_unit_number", 66 "desired_unit_type": "desired_unit_type", 67 "email_1": "email_1", 68 "email_2": "email_2", 69 "first_name": "first_name", 70 "ils": "ils", 71 "last_name": "last_name", 72 "lead_source": "lead_source", 73 "leasing_agent": "leasing_agent", 74 "middle_name": "middle_name", 75 "notes": "notes", 76 "number_of_occupants": 1, 77 "phone_1_type": "phone_1_type", 78 "phone_1": "phone_1", 79 "phone_2_type": "phone_2_type", 80 "phone_2": "phone_2", 81 "state": "state", 82 "status": "status", 83 "target_move_in_date": "target_move_in_date", 84 "zip": "zip", 85 "lead_source_id": "lead_source_id", 86 "x_unit_id": "x_unit_id", 87 "pet_details": "pet_details" 88 } 89 ] 90 }

Get all leads

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 (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations.

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 associated with the data diff

Response

Successful response

metaobject

resultslist of objects

Headers

Query parameters

Response

Errors