GET /v1/:facility_id/leads
Show all leads
You can filter leads by channel category. The field channel has these possible values: system, tenant_portal, sales_center, web, print, other, web_popup
Examples
GET /v1/fcac6ae3-3974-4e21-9078-8a572eb596cb/leads
200
{
"leads": [
{
"id": "8efb5bf7-29fa-4017-85b6-0fc586178858",
"bilingual_agent": false,
"caller_first_name": null,
"caller_last_name": null,
"cancelled_at": null,
"closed": false,
"confirmation_number": "1000001-1-1646",
"created_at": "2022-09-12T22:36:37.780-10:00",
"desired_move_in_date": "2022-09-14",
"desired_unit_size_and_price": "6x4x6 at $473.74",
"due_at_move_in": 268.45,
"due_monthly": 473.74,
"extra_details": {
"snapshot_reservation_id": "913efa2a-185c-4122-b36a-a0bcabfe7aee"
},
"facility_id": "fcac6ae3-3974-4e21-9078-8a572eb596cb",
"facility_time_zone": "Hawaii",
"floor": null,
"free_truck": false,
"has_paid_reservation_fee": null,
"invoiceable_fees": [],
"kind": "walk_in",
"lead_action_indexes": {},
"length_of_stay_id": null,
"move_in_from_reservation_url": null,
"moved_in_at": null,
"moving_labor": false,
"moving_labor_contacted_already": false,
"next_action_at": "2022-09-13T22:36:37.759-10:00",
"next_lead_action": null,
"next_lead_action_index": null,
"origination": "lead",
"plant_a_tree": false,
"quoted_rate": 473.74,
"rate_type": null,
"reduced_price": 473.74,
"reservation_fee_required": null,
"reservation_window": 0,
"reserved_at": "2022-09-12T22:36:37.819-10:00",
"size": "6x4x6",
"source_id": null,
"source_name": null,
"standard_rate": null,
"started_at": "2022-09-12T22:36:37.781-10:00",
"status": "reserved",
"tenant_id": "dc9f59ec-0ea9-4f0f-910b-53acde7dfc23",
"urgent": false,
"wait_list": false,
"wait_list_available": false,
"within_reservation_window": true,
"is_upgrade": null,
"desired_unit_size_and_amenities": null,
"tenant": {
"id": "dc9f59ec-0ea9-4f0f-910b-53acde7dfc23",
"account_number": 1000001,
"first_name": "Sonia39",
"last_name": "Wehner",
"middle_initial": null,
"email": "cordell@mills.biz39",
"tax_exempt": false,
"is_military": false,
"is_business": false,
"business_name": null,
"last_sign_in_at": null,
"title": null,
"delinquent": false,
"current_ledger_ids": [],
"preferences": {
"email_invoices": true,
"print_invoices": false,
"charge_invoice_fee": true,
"receive_legal_notices_by_email": null,
"delinquency_exempt": false,
"delinquency_docs_by_email": false,
"delinquency_docs_by_mail": false,
"receive_sms_for_gate_activity": false,
"opt_in_to_marketing_emails": false,
"opt_in_to_marketing_sms": false,
"opt_in_to_transactional_sms": false,
"exclude_from_insurance_auto_enroll": false,
"exclude_from_insurance_auto_enroll_reason": null,
"exclude_from_insurance_auto_enroll_created_by": null,
"exclude_from_insurance_auto_enroll_on": null
},
"military_information": null,
"username": "username_39",
"drivers_license_number": null,
"drivers_license_state": null,
"vehicle_license_plate_number": null,
"vehicle_license_state": null,
"vehicle_description": null,
"has_tenant_portal_account": false,
"created_at": "2022-09-12T22:36:37.766-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [],
"mailing_address": {
"id": "e27b22ba-4929-4a07-8990-6a121ea861c3",
"address1": "2895396 Lebsack Station",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "2895396 Lebsack Station, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "e27b22ba-4929-4a07-8990-6a121ea861c3",
"address1": "2895396 Lebsack Station",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "2895396 Lebsack Station, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "fcac6ae3-3974-4e21-9078-8a572eb596cb",
"previous_ledger_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"50c1e8e2-89d7-4aa8-b2c5-79880f2fa981"
],
"password_recovery_question_ids": [
"7f5732e4-5234-46b5-b0ab-d37a650c94d1",
"8ba74437-1469-4546-a619-12654a775dd4"
]
},
"unit": {
"id": "0bc2afeb-e53a-4434-8dd2-4f7145a51d04",
"price": 473.74,
"name": "U29",
"description": "",
"width": 6.0,
"length": 4.0,
"height": 6.0,
"door_height": 3.0,
"door_width": 4.0,
"door_type": "roll_up",
"access_type": "indoor",
"floor": null,
"directions": null,
"size": "6x4x6",
"area": 24.0,
"standard_rate": 473.74,
"managed_rate": null,
"available_for_move_in": false,
"rentable": true,
"status": "reserved",
"payment_status": null,
"current_ledger_id": null,
"current_tenant_id": null,
"combo_lock_group": null,
"combination_lock_number": null,
"overlock_lock_number": null,
"attribute_description": null,
"deleted": false,
"damaged": false,
"complimentary": null,
"unrentable": false,
"company_owned": false,
"is_prepped": null,
"tiering": {
"cross_sell_group_id": 1952,
"descriptor": "No Tier",
"tiered_amenities": []
},
"custom_fields": [],
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "bbdc8a10-9ea8-41bb-bd99-9e66dce71bf8",
"name": "Unit Type 29",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"unit_group_id": "6870d400-0a1a-4e46-8d20-0b706ea4dd74"
},
"length_of_stay": null,
"successful_payment_events": [],
"caller_phone_number": null,
"unit_amenities": [],
"current_user": null,
"unit_type": {
"id": "bbdc8a10-9ea8-41bb-bd99-9e66dce71bf8",
"name": "Unit Type 29",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"close_reason": null,
"discount_plans": [],
"lead_contents": [],
"unit_group": {
"id": "6870d400-0a1a-4e46-8d20-0b706ea4dd74",
"price": 473.74,
"group_key": "6x4x6 - $473.74 - 1999",
"name": "6x4x6 - $473.74 - 1999",
"available_units_count": 0,
"total_units_count": 1,
"total_non_excluded_units_count": 1,
"size": "6x4x6",
"standard_rate": 473.74,
"floor": null,
"reduced_price": 473.74,
"cyo_reduced_prices": {},
"occupancy_percent": 0.0,
"area": 24.0,
"length": 4.0,
"width": 6.0,
"height": 6.0,
"due_at_move_in": 473.74,
"due_at_move_in_without_fees": 473.74,
"due_monthly": 473.74,
"attribute_description": null,
"description": "",
"invoiceable_fees": [],
"average_rent": 0.0,
"active_rate_type": "standard_rate",
"scheduled_move_outs": [],
"managed_rate": null,
"reservation_fee": null,
"tiering": {
"cross_sell_group_id": 1952,
"descriptor": "No Tier",
"justification": null,
"tiered_amenities": []
},
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "bbdc8a10-9ea8-41bb-bd99-9e66dce71bf8",
"name": "Unit Type 29",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"discount_plans": [],
"channel_rate_ids": [],
"available_upgrade_to_unit_groups": []
},
"created_by": {
"id": "ec4fb36f-f507-4573-9fa7-de62a9117965",
"name": "Test App",
"type": "Source"
},
"channel_id": null,
"confirmation_email": null
},
{
"id": "5dcf839c-8fac-4c63-8e09-ebf7db2a55a3",
"bilingual_agent": false,
"caller_first_name": null,
"caller_last_name": null,
"cancelled_at": null,
"closed": false,
"confirmation_number": null,
"created_at": "2022-09-12T22:36:37.735-10:00",
"desired_move_in_date": "2022-09-12",
"desired_unit_size_and_price": null,
"due_at_move_in": null,
"due_monthly": null,
"extra_details": {},
"facility_id": "fcac6ae3-3974-4e21-9078-8a572eb596cb",
"facility_time_zone": "Hawaii",
"floor": null,
"free_truck": false,
"has_paid_reservation_fee": null,
"invoiceable_fees": [],
"kind": "walk_in",
"lead_action_indexes": {},
"length_of_stay_id": null,
"move_in_from_reservation_url": null,
"moved_in_at": null,
"moving_labor": false,
"moving_labor_contacted_already": false,
"next_action_at": "2022-09-13T22:36:37.656-10:00",
"next_lead_action": null,
"next_lead_action_index": null,
"origination": "lead",
"plant_a_tree": false,
"quoted_rate": null,
"rate_type": null,
"reduced_price": null,
"reservation_fee_required": null,
"reservation_window": 0,
"reserved_at": null,
"size": null,
"source_id": null,
"source_name": null,
"standard_rate": null,
"started_at": "2022-09-12T22:36:37.735-10:00",
"status": "created",
"tenant_id": "e3d019a7-6358-4db5-b4db-981c7cc6efd2",
"urgent": false,
"wait_list": false,
"wait_list_available": false,
"within_reservation_window": true,
"is_upgrade": null,
"desired_unit_size_and_amenities": null,
"tenant": {
"id": "e3d019a7-6358-4db5-b4db-981c7cc6efd2",
"account_number": 1000000,
"first_name": "Alethia38",
"last_name": "Wehner",
"middle_initial": null,
"email": "jacintoadams@dooley.co38",
"tax_exempt": false,
"is_military": false,
"is_business": false,
"business_name": null,
"last_sign_in_at": null,
"title": null,
"delinquent": false,
"current_ledger_ids": [],
"preferences": {
"email_invoices": true,
"print_invoices": false,
"charge_invoice_fee": true,
"receive_legal_notices_by_email": null,
"delinquency_exempt": false,
"delinquency_docs_by_email": false,
"delinquency_docs_by_mail": false,
"receive_sms_for_gate_activity": false,
"opt_in_to_marketing_emails": false,
"opt_in_to_marketing_sms": false,
"opt_in_to_transactional_sms": false,
"exclude_from_insurance_auto_enroll": false,
"exclude_from_insurance_auto_enroll_reason": null,
"exclude_from_insurance_auto_enroll_created_by": null,
"exclude_from_insurance_auto_enroll_on": null
},
"military_information": null,
"username": "username_38",
"drivers_license_number": null,
"drivers_license_state": null,
"vehicle_license_plate_number": null,
"vehicle_license_state": null,
"vehicle_description": null,
"has_tenant_portal_account": false,
"created_at": "2022-09-12T22:36:37.712-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [],
"mailing_address": {
"id": "146e4e35-8e2c-46aa-83e8-e09a10bedcde",
"address1": "288220 Andrew Drive",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "288220 Andrew Drive, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "146e4e35-8e2c-46aa-83e8-e09a10bedcde",
"address1": "288220 Andrew Drive",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "288220 Andrew Drive, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "fcac6ae3-3974-4e21-9078-8a572eb596cb",
"previous_ledger_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"ffcb810a-7b55-4c31-bfba-a3efc3f34580"
],
"password_recovery_question_ids": [
"1dd7c92f-2494-4a3f-a2ec-0e1c48d204a0",
"5537b141-283d-4a6b-966b-60a7caf0f7b3"
]
},
"unit": null,
"length_of_stay": null,
"successful_payment_events": [],
"caller_phone_number": null,
"unit_amenities": [],
"current_user": null,
"unit_type": null,
"close_reason": null,
"discount_plans": [],
"lead_contents": [],
"unit_group": null,
"created_by": {
"id": "ec4fb36f-f507-4573-9fa7-de62a9117965",
"name": "Test App",
"type": "Source"
},
"channel_id": null,
"confirmation_email": null
}
],
"meta": {
"pagination": {
"current_page": 1,
"total_pages": 1,
"per_page": 100,
"total_entries": 2,
"previous_page": null,
"next_page": null
},
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "GET",
"request_id": null,
"parameters": {
"facility_id": "fcac6ae3-3974-4e21-9078-8a572eb596cb"
}
}
}
Params
| Param name | Description |
|---|---|
|
channel_category optional |
Value: Must be one of: <code>system</code>, <code>tenant_portal</code>, <code>sales_center</code>, <code>web</code>, <code>print</code>, <code>other</code>, <code>web_popup</code>. |