GET /v1/:facility_id/leads/reservations
Show all leads that are reservations
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/de9e68eb-ae53-43e8-b450-4481e6fa70c7/leads/reservations
200
{
"leads": [
{
"id": "7d58f4bb-ada5-4a3f-af27-30c2e9889a78",
"bilingual_agent": false,
"caller_first_name": null,
"caller_last_name": null,
"cancelled_at": null,
"closed": false,
"confirmation_number": "1000001-1-2694",
"created_at": "2023-09-15T04:38:04.714-10:00",
"desired_move_in_date": "2023-09-17",
"desired_unit_size_and_price": "10x6x8 at $537.73",
"due_at_move_in": 250.94,
"due_monthly": 537.73,
"extra_details": {
"snapshot_reservation_id": "c9b5a60f-0c68-48e0-96f3-2bed2b0b997f"
},
"facility_id": "de9e68eb-ae53-43e8-b450-4481e6fa70c7",
"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:04.680-10:00",
"next_lead_action": null,
"next_lead_action_index": null,
"origination": "lead",
"plant_a_tree": false,
"quoted_rate": 537.73,
"rate_type": null,
"reduced_price": 537.73,
"reservation_fee_required": null,
"reservation_window": 0,
"reserved_at": "2023-09-15T04:38:04.782-10:00",
"size": "10x6x8",
"source_id": null,
"source_name": null,
"standard_rate": null,
"started_at": "2023-09-15T04:38:04.714-10:00",
"status": "reserved",
"tenant_id": "8184b01c-7c17-4c55-a1d6-ece9f947fd69",
"urgent": false,
"wait_list": false,
"wait_list_available": false,
"within_reservation_window": true,
"is_upgrade": null,
"desired_unit_size_and_amenities": null,
"tenant": {
"id": "8184b01c-7c17-4c55-a1d6-ece9f947fd69",
"account_number": 1000001,
"first_name": "Juliana122",
"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_122",
"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:04.694-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": "c143752c-2bd0-4685-9c1b-53abc43a2cda",
"address1": "74991904 Treutel Ferry",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "74991904 Treutel Ferry, 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": "c143752c-2bd0-4685-9c1b-53abc43a2cda",
"address1": "74991904 Treutel Ferry",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "74991904 Treutel Ferry, 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": "de9e68eb-ae53-43e8-b450-4481e6fa70c7",
"previous_ledger_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"e69713ad-ddc3-4b44-8dd3-4cdbf0dd4371"
],
"password_recovery_question_ids": [
"f0e59f3d-012d-48b3-84dd-36730c79219a",
"037bef8e-de63-4f10-97fc-b139cb90a2d4"
]
},
"unit": {
"id": "7cd03be5-d816-43f6-b702-0117ec75dc91",
"price": 537.73,
"name": "U83",
"description": "",
"width": 10.0,
"length": 6.0,
"height": 8.0,
"door_height": 2.0,
"door_width": 4.0,
"door_type": "roll_up",
"access_type": "indoor",
"floor": null,
"directions": null,
"size": "10x6x8",
"area": 60.0,
"standard_rate": 537.73,
"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": "3a229d9c-76ea-413e-9ba5-5b6425fefa6d",
"name": "Unit Type 106",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"tier": null,
"unit_group_id": "e609b386-96c3-4366-9a32-804126311868"
},
"length_of_stay": null,
"successful_payment_events": [],
"caller_phone_number": null,
"unit_amenities": [],
"current_user": null,
"unit_type": {
"id": "3a229d9c-76ea-413e-9ba5-5b6425fefa6d",
"name": "Unit Type 106",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"close_reason": null,
"discount_plans": [],
"lead_contents": [],
"unit_group": {
"id": "e609b386-96c3-4366-9a32-804126311868",
"price": 537.73,
"group_key": "10x6x8 - $537.73 - 3193",
"name": "U83 - Group",
"available_units_count": 0,
"total_units_count": 1,
"total_non_excluded_units_count": 1,
"size": "10x6x8",
"standard_rate": 537.73,
"floor": null,
"reduced_price": 537.73,
"cyo_reduced_prices": {},
"occupancy_percent": 0.0,
"area": 60.0,
"length": 6.0,
"width": 10.0,
"height": 8.0,
"due_at_move_in": 537.73,
"due_at_move_in_without_fees": 537.73,
"due_monthly": 537.73,
"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": "3a229d9c-76ea-413e-9ba5-5b6425fefa6d",
"name": "Unit Type 106",
"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": "f6a65880-c14e-43bf-bb77-591980e1192e",
"name": "Test App",
"type": "Source"
},
"channel_id": null,
"confirmation_email": null
}
],
"meta": {
"pagination": {
"current_page": 1,
"total_pages": 1,
"per_page": 100,
"total_entries": 1,
"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": "de9e68eb-ae53-43e8-b450-4481e6fa70c7",
"lead": {}
}
}
}