GET /v1/:facility_id/leads
Show all leads
You can filter leads by channel category. #### Allowed values for channel
* other
* print
* sales_center
* system
* tenant_portal
* web
* web_popup
Params
| Param name | Description |
|---|---|
|
channel_category
optional |
Validations:
|
Examples
GET /v1/81926459-9d09-4862-a7ad-3279f3a71b8b/leads
200
{
"leads": [
{
"id": "215d6043-1122-4141-b0cd-c58c67eb2f0b",
"bilingual_agent": false,
"caller_first_name": null,
"caller_last_name": null,
"cancelled_at": null,
"closed": false,
"confirmation_number": "1000001-1-2700",
"created_at": "2023-09-15T04:38:06.582-10:00",
"desired_move_in_date": "2023-09-17",
"desired_unit_size_and_price": "9x5x4 at $926.12",
"due_at_move_in": 432.19,
"due_monthly": 926.12,
"extra_details": {
"snapshot_reservation_id": "042fffbf-7417-4446-9b07-47ee778e649c"
},
"facility_id": "81926459-9d09-4862-a7ad-3279f3a71b8b",
"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": "2023-09-16T04:38:06.549-10:00",
"next_lead_action": null,
"next_lead_action_index": null,
"origination": "lead",
"plant_a_tree": false,
"quoted_rate": 926.12,
"rate_type": null,
"reduced_price": 926.12,
"reservation_fee_required": null,
"reservation_window": 0,
"reserved_at": "2023-09-15T04:38:06.664-10:00",
"size": "9x5x4",
"source_id": null,
"source_name": null,
"standard_rate": null,
"started_at": "2023-09-15T04:38:06.582-10:00",
"status": "reserved",
"tenant_id": "6ce5a49c-0ce7-4f8f-b32b-3f39e02ec204",
"urgent": false,
"wait_list": false,
"wait_list_available": false,
"within_reservation_window": true,
"is_upgrade": null,
"desired_unit_size_and_amenities": null,
"tenant": {
"id": "6ce5a49c-0ce7-4f8f-b32b-3f39e02ec204",
"account_number": 1000001,
"first_name": "Noemi128",
"last_name": "Quigley",
"middle_initial": null,
"email": "[email protected]",
"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_128",
"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": "2023-09-15T04:38:06.562-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": "22a170b8-f9ca-42e2-a8a1-741833b96803",
"address1": "76542754 Wilfredo Club",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "76542754 Wilfredo Club, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "22a170b8-f9ca-42e2-a8a1-741833b96803",
"address1": "76542754 Wilfredo Club",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "76542754 Wilfredo Club, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "81926459-9d09-4862-a7ad-3279f3a71b8b",
"previous_ledger_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"925d9cb3-c5ed-4791-a595-af8e4057c870"
],
"password_recovery_question_ids": [
"9a973688-33fb-496f-ad8a-55f1e915e419",
"5a7fce44-b6ff-464b-80a4-e333dae07f79"
]
},
"unit": {
"id": "3816382c-ca46-4ea5-89ee-f74dc5e22511",
"price": 926.12,
"name": "U85",
"description": "",
"width": 9.0,
"length": 5.0,
"height": 4.0,
"door_height": 9.0,
"door_width": 4.0,
"door_type": "roll_up",
"access_type": "indoor",
"floor": null,
"directions": null,
"size": "9x5x4",
"area": 45.0,
"standard_rate": 926.12,
"managed_rate": null,
"tiered_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,
"rank": null,
"custom_fields": [],
"allow_future_move_ins_limit": null,
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "01108e7c-984b-41f1-809f-8e9e8265e80e",
"name": "Unit Type 108",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"tier": null,
"unit_group_id": "aa33a8eb-55a8-4659-b922-39b380d72445"
},
"length_of_stay": null,
"successful_payment_events": [],
"caller_phone_number": null,
"unit_amenities": [],
"current_user": null,
"unit_type": {
"id": "01108e7c-984b-41f1-809f-8e9e8265e80e",
"name": "Unit Type 108",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"close_reason": null,
"discount_plans": [],
"lead_contents": [],
"unit_group": {
"id": "aa33a8eb-55a8-4659-b922-39b380d72445",
"price": 926.12,
"group_key": "9x5x4 - $926.12 - 3195",
"name": "U85 - Group",
"available_units_count": 0,
"total_units_count": 1,
"total_non_excluded_units_count": 1,
"size": "9x5x4",
"standard_rate": 926.12,
"floor": null,
"reduced_price": 926.12,
"cyo_reduced_prices": {},
"occupancy_percent": 0.0,
"area": 45.0,
"length": 5.0,
"width": 9.0,
"height": 4.0,
"due_at_move_in": 926.12,
"due_at_move_in_without_fees": 926.12,
"due_monthly": 926.12,
"attribute_description": null,
"description": "",
"invoiceable_fees": [],
"average_rent": 0.0,
"active_rate_type": "standard_rate",
"scheduled_move_outs": [],
"managed_rate": null,
"reservation_fee": null,
"reference_unit_id": null,
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "01108e7c-984b-41f1-809f-8e9e8265e80e",
"name": "Unit Type 108",
"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": "4534d050-eb3e-4e4c-9ec1-a8d7a92e0914",
"name": "Test App",
"type": "Source"
},
"channel_id": null,
"confirmation_email": null
},
{
"id": "eb5f0a64-cd43-4743-bde8-7f80673a7d9c",
"bilingual_agent": false,
"caller_first_name": null,
"caller_last_name": null,
"cancelled_at": null,
"closed": false,
"confirmation_number": null,
"created_at": "2023-09-15T04:38:06.509-10:00",
"desired_move_in_date": "2023-09-15",
"desired_unit_size_and_price": null,
"due_at_move_in": null,
"due_monthly": null,
"extra_details": {},
"facility_id": "81926459-9d09-4862-a7ad-3279f3a71b8b",
"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": "2023-09-16T04:38:06.477-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": "2023-09-15T04:38:06.509-10:00",
"status": "created",
"tenant_id": "cc00bc8a-b4de-4945-a144-4e8b49ba5314",
"urgent": false,
"wait_list": false,
"wait_list_available": false,
"within_reservation_window": true,
"is_upgrade": null,
"desired_unit_size_and_amenities": null,
"tenant": {
"id": "cc00bc8a-b4de-4945-a144-4e8b49ba5314",
"account_number": 1000000,
"first_name": "Verena127",
"last_name": "Quigley",
"middle_initial": null,
"email": "[email protected]",
"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_127",
"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": "2023-09-15T04:38:06.489-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": "a8f6e8c6-9121-48cc-9f77-0b80edc16429",
"address1": "764684 Heidenreich Rest",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "764684 Heidenreich Rest, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "a8f6e8c6-9121-48cc-9f77-0b80edc16429",
"address1": "764684 Heidenreich Rest",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "764684 Heidenreich Rest, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "81926459-9d09-4862-a7ad-3279f3a71b8b",
"previous_ledger_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"3d35ce4a-91ce-4609-9df1-e440d02ee632"
],
"password_recovery_question_ids": [
"62b938d5-10fd-4072-abc5-3b298f232715",
"63df17d2-61b1-4e9b-9117-50df337a15a0"
]
},
"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": "4534d050-eb3e-4e4c-9ec1-a8d7a92e0914",
"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": "81926459-9d09-4862-a7ad-3279f3a71b8b",
"lead": {}
}
}
}