GET /v1/:facility_id/tenants/:tenant_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/91284a4a-2695-4e28-add1-028d65725b7f/tenants/f5c3389c-daf3-48a0-9497-caa695232c18/leads
200
{
  "leads": [
    {
      "id": "69f1e7e3-554c-434d-a5d8-d0fbf3bad6f8",
      "bilingual_agent": false,
      "caller_first_name": null,
      "caller_last_name": null,
      "cancelled_at": null,
      "closed": false,
      "confirmation_number": "1000000-1-1780",
      "created_at": "2022-09-12T22:37:11.360-10:00",
      "desired_move_in_date": "2022-09-15",
      "desired_unit_size_and_price": "8x5x7 at $847.75",
      "due_at_move_in": 452.13,
      "due_monthly": 847.75,
      "extra_details": {
        "snapshot_reservation_id": "7386a2ef-496f-4203-b9a0-a6f9c35a8e80",
        "previous_snapshot_reservation_id": "ba4305f4-355d-4a7f-bc73-0d7beee38b71"
      },
      "facility_id": "91284a4a-2695-4e28-add1-028d65725b7f",
      "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": null,
      "next_lead_action": null,
      "next_lead_action_index": null,
      "origination": "lead",
      "plant_a_tree": false,
      "quoted_rate": 847.75,
      "rate_type": null,
      "reduced_price": 847.75,
      "reservation_fee_required": null,
      "reservation_window": 0,
      "reserved_at": "2022-09-12T22:37:11.599-10:00",
      "size": "8x5x7",
      "source_id": null,
      "source_name": null,
      "standard_rate": null,
      "started_at": "2022-09-12T22:37:11.360-10:00",
      "status": "reserved",
      "tenant_id": "f5c3389c-daf3-48a0-9497-caa695232c18",
      "urgent": false,
      "wait_list": false,
      "wait_list_available": false,
      "within_reservation_window": true,
      "is_upgrade": null,
      "desired_unit_size_and_amenities": null,
      "tenant": {
        "id": "f5c3389c-daf3-48a0-9497-caa695232c18",
        "account_number": 1000000,
        "first_name": "Germaine170",
        "last_name": "Wehner",
        "middle_initial": null,
        "email": "dongbeatty@kutchkuvalis.io172",
        "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_170",
        "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:37:10.933-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": "e5b90c94-bbf8-45bf-b04d-84327d0d793c",
          "address1": "7594354 Jc Ports",
          "address2": null,
          "city": "South Jessie",
          "state": "CT",
          "postal": "39384",
          "country": "US",
          "full_address": "7594354 Jc Ports, 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": "e5b90c94-bbf8-45bf-b04d-84327d0d793c",
            "address1": "7594354 Jc Ports",
            "address2": null,
            "city": "South Jessie",
            "state": "CT",
            "postal": "39384",
            "country": "US",
            "full_address": "7594354 Jc Ports, 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": "91284a4a-2695-4e28-add1-028d65725b7f",
        "previous_ledger_ids": [],
        "closed_lead_ids": [
          "0ec77cfc-e86c-4d75-b2c4-a9c704865398"
        ],
        "contact_ids": [],
        "support_case_ids": [],
        "event_ids": [
          "3012d137-6a35-4dba-905c-dfe64b3bb0ac",
          "a81eef11-6e1d-4363-8a90-bbff74aa084b",
          "d6a9072c-aec9-4da3-b603-e85faa9abf54",
          "8ef1a0ea-0e85-4731-b604-e96ff08d2f7b"
        ],
        "password_recovery_question_ids": [
          "e09f5061-5f0c-4531-bdc3-d2717a964465",
          "c0e4263d-7b93-41e3-98d3-0ab7495e1c4d"
        ]
      },
      "unit": {
        "id": "392f4104-5668-4c17-8fef-a6aca60bc527",
        "price": 847.75,
        "name": "U116",
        "description": "",
        "width": 8.0,
        "length": 5.0,
        "height": 7.0,
        "door_height": 10.0,
        "door_width": 2.0,
        "door_type": "roll_up",
        "access_type": "indoor",
        "floor": null,
        "directions": null,
        "size": "8x5x7",
        "area": 40.0,
        "standard_rate": 847.75,
        "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": 2039,
          "descriptor": "No Tier",
          "tiered_amenities": []
        },
        "custom_fields": [],
        "channel_rate": null,
        "unit_amenities": [],
        "unit_type": {
          "id": "d431218e-a40a-415a-ab8d-1ae33a16a9a2",
          "name": "Unit Type 132",
          "deleted": false,
          "internal_account_code": "4000",
          "code_and_description": "4000 - Rental Revenue",
          "ii_excluded": []
        },
        "unit_group_id": "d480f96f-1008-4131-b210-1e05552e4606"
      },
      "length_of_stay": null,
      "successful_payment_events": [],
      "caller_phone_number": null,
      "unit_amenities": [],
      "current_user": null,
      "unit_type": {
        "id": "d431218e-a40a-415a-ab8d-1ae33a16a9a2",
        "name": "Unit Type 132",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "close_reason": null,
      "discount_plans": [],
      "lead_contents": [],
      "unit_group": {
        "id": "d480f96f-1008-4131-b210-1e05552e4606",
        "price": 847.75,
        "group_key": "8x5x7 - $847.75 - 2103",
        "name": "8x5x7 - $847.75 - 2103",
        "available_units_count": 0,
        "total_units_count": 1,
        "total_non_excluded_units_count": 1,
        "size": "8x5x7",
        "standard_rate": 847.75,
        "floor": null,
        "reduced_price": 847.75,
        "cyo_reduced_prices": {},
        "occupancy_percent": 0.0,
        "area": 40.0,
        "length": 5.0,
        "width": 8.0,
        "height": 7.0,
        "due_at_move_in": 847.75,
        "due_at_move_in_without_fees": 847.75,
        "due_monthly": 847.75,
        "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": 2039,
          "descriptor": "No Tier",
          "justification": null,
          "tiered_amenities": []
        },
        "channel_rate": null,
        "unit_amenities": [],
        "unit_type": {
          "id": "d431218e-a40a-415a-ab8d-1ae33a16a9a2",
          "name": "Unit Type 132",
          "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": "5e7f9786-9ee9-48e6-89e0-d3c8a50d4f2a",
        "name": "Test App",
        "type": "Source"
      },
      "channel_id": null,
      "confirmation_email": null
    },
    {
      "id": "0ec77cfc-e86c-4d75-b2c4-a9c704865398",
      "bilingual_agent": false,
      "caller_first_name": null,
      "caller_last_name": null,
      "cancelled_at": "2022-09-12T22:37:11.329-10:00",
      "closed": true,
      "confirmation_number": null,
      "created_at": "2022-09-12T22:37:10.961-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": "91284a4a-2695-4e28-add1-028d65725b7f",
      "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": null,
      "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:37:10.961-10:00",
      "status": "cancelled",
      "tenant_id": "f5c3389c-daf3-48a0-9497-caa695232c18",
      "urgent": false,
      "wait_list": false,
      "wait_list_available": false,
      "within_reservation_window": true,
      "is_upgrade": null,
      "desired_unit_size_and_amenities": null,
      "tenant": {
        "id": "f5c3389c-daf3-48a0-9497-caa695232c18",
        "account_number": 1000000,
        "first_name": "Germaine170",
        "last_name": "Wehner",
        "middle_initial": null,
        "email": "dongbeatty@kutchkuvalis.io172",
        "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_170",
        "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:37:10.933-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": "e5b90c94-bbf8-45bf-b04d-84327d0d793c",
          "address1": "7594354 Jc Ports",
          "address2": null,
          "city": "South Jessie",
          "state": "CT",
          "postal": "39384",
          "country": "US",
          "full_address": "7594354 Jc Ports, 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": "e5b90c94-bbf8-45bf-b04d-84327d0d793c",
            "address1": "7594354 Jc Ports",
            "address2": null,
            "city": "South Jessie",
            "state": "CT",
            "postal": "39384",
            "country": "US",
            "full_address": "7594354 Jc Ports, 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": "91284a4a-2695-4e28-add1-028d65725b7f",
        "previous_ledger_ids": [],
        "closed_lead_ids": [
          "0ec77cfc-e86c-4d75-b2c4-a9c704865398"
        ],
        "contact_ids": [],
        "support_case_ids": [],
        "event_ids": [
          "3012d137-6a35-4dba-905c-dfe64b3bb0ac",
          "a81eef11-6e1d-4363-8a90-bbff74aa084b",
          "d6a9072c-aec9-4da3-b603-e85faa9abf54",
          "8ef1a0ea-0e85-4731-b604-e96ff08d2f7b"
        ],
        "password_recovery_question_ids": [
          "e09f5061-5f0c-4531-bdc3-d2717a964465",
          "c0e4263d-7b93-41e3-98d3-0ab7495e1c4d"
        ]
      },
      "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": "5e7f9786-9ee9-48e6-89e0-d3c8a50d4f2a",
        "name": "Test App",
        "type": "Source"
      },
      "channel_id": null,
      "confirmation_email": null
    },
    {
      "id": "4c7c349d-61da-40c1-879c-0edb45d2e87e",
      "bilingual_agent": false,
      "caller_first_name": null,
      "caller_last_name": null,
      "cancelled_at": null,
      "closed": false,
      "confirmation_number": null,
      "created_at": "2022-09-12T22:37:11.250-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": "91284a4a-2695-4e28-add1-028d65725b7f",
      "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": null,
      "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:37:11.250-10:00",
      "status": "created",
      "tenant_id": "f5c3389c-daf3-48a0-9497-caa695232c18",
      "urgent": false,
      "wait_list": false,
      "wait_list_available": false,
      "within_reservation_window": true,
      "is_upgrade": null,
      "desired_unit_size_and_amenities": null,
      "tenant": {
        "id": "f5c3389c-daf3-48a0-9497-caa695232c18",
        "account_number": 1000000,
        "first_name": "Germaine170",
        "last_name": "Wehner",
        "middle_initial": null,
        "email": "dongbeatty@kutchkuvalis.io172",
        "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_170",
        "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:37:10.933-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": "e5b90c94-bbf8-45bf-b04d-84327d0d793c",
          "address1": "7594354 Jc Ports",
          "address2": null,
          "city": "South Jessie",
          "state": "CT",
          "postal": "39384",
          "country": "US",
          "full_address": "7594354 Jc Ports, 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": "e5b90c94-bbf8-45bf-b04d-84327d0d793c",
            "address1": "7594354 Jc Ports",
            "address2": null,
            "city": "South Jessie",
            "state": "CT",
            "postal": "39384",
            "country": "US",
            "full_address": "7594354 Jc Ports, 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": "91284a4a-2695-4e28-add1-028d65725b7f",
        "previous_ledger_ids": [],
        "closed_lead_ids": [
          "0ec77cfc-e86c-4d75-b2c4-a9c704865398"
        ],
        "contact_ids": [],
        "support_case_ids": [],
        "event_ids": [
          "3012d137-6a35-4dba-905c-dfe64b3bb0ac",
          "a81eef11-6e1d-4363-8a90-bbff74aa084b",
          "d6a9072c-aec9-4da3-b603-e85faa9abf54",
          "8ef1a0ea-0e85-4731-b604-e96ff08d2f7b"
        ],
        "password_recovery_question_ids": [
          "e09f5061-5f0c-4531-bdc3-d2717a964465",
          "c0e4263d-7b93-41e3-98d3-0ab7495e1c4d"
        ]
      },
      "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": "5e7f9786-9ee9-48e6-89e0-d3c8a50d4f2a",
        "name": "Test App",
        "type": "Source"
      },
      "channel_id": null,
      "confirmation_email": null
    },
    {
      "id": "a5066993-cc7f-4f67-bf60-68d2db572bbb",
      "bilingual_agent": false,
      "caller_first_name": null,
      "caller_last_name": null,
      "cancelled_at": null,
      "closed": false,
      "confirmation_number": null,
      "created_at": "2022-09-12T22:37:11.150-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": "91284a4a-2695-4e28-add1-028d65725b7f",
      "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": null,
      "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:37:11.150-10:00",
      "status": "created",
      "tenant_id": "f5c3389c-daf3-48a0-9497-caa695232c18",
      "urgent": false,
      "wait_list": false,
      "wait_list_available": false,
      "within_reservation_window": true,
      "is_upgrade": null,
      "desired_unit_size_and_amenities": null,
      "tenant": {
        "id": "f5c3389c-daf3-48a0-9497-caa695232c18",
        "account_number": 1000000,
        "first_name": "Germaine170",
        "last_name": "Wehner",
        "middle_initial": null,
        "email": "dongbeatty@kutchkuvalis.io172",
        "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_170",
        "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:37:10.933-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": "e5b90c94-bbf8-45bf-b04d-84327d0d793c",
          "address1": "7594354 Jc Ports",
          "address2": null,
          "city": "South Jessie",
          "state": "CT",
          "postal": "39384",
          "country": "US",
          "full_address": "7594354 Jc Ports, 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": "e5b90c94-bbf8-45bf-b04d-84327d0d793c",
            "address1": "7594354 Jc Ports",
            "address2": null,
            "city": "South Jessie",
            "state": "CT",
            "postal": "39384",
            "country": "US",
            "full_address": "7594354 Jc Ports, 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": "91284a4a-2695-4e28-add1-028d65725b7f",
        "previous_ledger_ids": [],
        "closed_lead_ids": [
          "0ec77cfc-e86c-4d75-b2c4-a9c704865398"
        ],
        "contact_ids": [],
        "support_case_ids": [],
        "event_ids": [
          "3012d137-6a35-4dba-905c-dfe64b3bb0ac",
          "a81eef11-6e1d-4363-8a90-bbff74aa084b",
          "d6a9072c-aec9-4da3-b603-e85faa9abf54",
          "8ef1a0ea-0e85-4731-b604-e96ff08d2f7b"
        ],
        "password_recovery_question_ids": [
          "e09f5061-5f0c-4531-bdc3-d2717a964465",
          "c0e4263d-7b93-41e3-98d3-0ab7495e1c4d"
        ]
      },
      "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": "5e7f9786-9ee9-48e6-89e0-d3c8a50d4f2a",
        "name": "Test App",
        "type": "Source"
      },
      "channel_id": null,
      "confirmation_email": null
    },
    {
      "id": "d9eca371-9ec0-462e-83eb-5384310c1475",
      "bilingual_agent": false,
      "caller_first_name": null,
      "caller_last_name": null,
      "cancelled_at": null,
      "closed": false,
      "confirmation_number": null,
      "created_at": "2022-09-12T22:37:11.061-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": "91284a4a-2695-4e28-add1-028d65725b7f",
      "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": null,
      "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:37:11.061-10:00",
      "status": "created",
      "tenant_id": "f5c3389c-daf3-48a0-9497-caa695232c18",
      "urgent": false,
      "wait_list": false,
      "wait_list_available": false,
      "within_reservation_window": true,
      "is_upgrade": null,
      "desired_unit_size_and_amenities": null,
      "tenant": {
        "id": "f5c3389c-daf3-48a0-9497-caa695232c18",
        "account_number": 1000000,
        "first_name": "Germaine170",
        "last_name": "Wehner",
        "middle_initial": null,
        "email": "dongbeatty@kutchkuvalis.io172",
        "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_170",
        "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:37:10.933-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": "e5b90c94-bbf8-45bf-b04d-84327d0d793c",
          "address1": "7594354 Jc Ports",
          "address2": null,
          "city": "South Jessie",
          "state": "CT",
          "postal": "39384",
          "country": "US",
          "full_address": "7594354 Jc Ports, 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": "e5b90c94-bbf8-45bf-b04d-84327d0d793c",
            "address1": "7594354 Jc Ports",
            "address2": null,
            "city": "South Jessie",
            "state": "CT",
            "postal": "39384",
            "country": "US",
            "full_address": "7594354 Jc Ports, 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": "91284a4a-2695-4e28-add1-028d65725b7f",
        "previous_ledger_ids": [],
        "closed_lead_ids": [
          "0ec77cfc-e86c-4d75-b2c4-a9c704865398"
        ],
        "contact_ids": [],
        "support_case_ids": [],
        "event_ids": [
          "3012d137-6a35-4dba-905c-dfe64b3bb0ac",
          "a81eef11-6e1d-4363-8a90-bbff74aa084b",
          "d6a9072c-aec9-4da3-b603-e85faa9abf54",
          "8ef1a0ea-0e85-4731-b604-e96ff08d2f7b"
        ],
        "password_recovery_question_ids": [
          "e09f5061-5f0c-4531-bdc3-d2717a964465",
          "c0e4263d-7b93-41e3-98d3-0ab7495e1c4d"
        ]
      },
      "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": "5e7f9786-9ee9-48e6-89e0-d3c8a50d4f2a",
        "name": "Test App",
        "type": "Source"
      },
      "channel_id": null,
      "confirmation_email": null
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "total_pages": 1,
      "per_page": 100,
      "total_entries": 5,
      "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": "91284a4a-2695-4e28-add1-028d65725b7f",
      "tenant_id": "f5c3389c-daf3-48a0-9497-caa695232c18"
    }
  }
}

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>.

GET /v1/:facility_id/tenants/:tenant_id/leads/current
Show all current 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/fb4c7133-dd91-4856-9cdd-4393df623eef/tenants/1233de69-77ba-4936-a544-c84015b13585/leads/current
200
{
  "leads": [
    {
      "id": "c08aa611-f59e-44a9-aee2-ef0ed288c7d0",
      "bilingual_agent": false,
      "caller_first_name": null,
      "caller_last_name": null,
      "cancelled_at": null,
      "closed": false,
      "confirmation_number": "1000000-1-1744",
      "created_at": "2022-09-12T22:37:07.256-10:00",
      "desired_move_in_date": "2022-09-15",
      "desired_unit_size_and_price": "8x5x7 at $847.75",
      "due_at_move_in": 452.13,
      "due_monthly": 847.75,
      "extra_details": {
        "snapshot_reservation_id": "fd0af8e2-aa5b-4b80-b2d9-f3e786507938",
        "previous_snapshot_reservation_id": "61e98eba-e352-42b6-9033-fa33af846699"
      },
      "facility_id": "fb4c7133-dd91-4856-9cdd-4393df623eef",
      "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": null,
      "next_lead_action": null,
      "next_lead_action_index": null,
      "origination": "lead",
      "plant_a_tree": false,
      "quoted_rate": 847.75,
      "rate_type": null,
      "reduced_price": 847.75,
      "reservation_fee_required": null,
      "reservation_window": 0,
      "reserved_at": "2022-09-12T22:37:07.439-10:00",
      "size": "8x5x7",
      "source_id": null,
      "source_name": null,
      "standard_rate": null,
      "started_at": "2022-09-12T22:37:07.256-10:00",
      "status": "reserved",
      "tenant_id": "1233de69-77ba-4936-a544-c84015b13585",
      "urgent": false,
      "wait_list": false,
      "wait_list_available": false,
      "within_reservation_window": true,
      "is_upgrade": null,
      "desired_unit_size_and_amenities": null,
      "tenant": {
        "id": "1233de69-77ba-4936-a544-c84015b13585",
        "account_number": 1000000,
        "first_name": "Regine134",
        "last_name": "Wehner",
        "middle_initial": null,
        "email": "leilani@grady.io136",
        "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_134",
        "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:37:06.755-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": "c83bc210-d730-481c-b910-acf3656248cb",
          "address1": "7085488 Bradtke Shoal",
          "address2": null,
          "city": "South Jessie",
          "state": "CT",
          "postal": "39384",
          "country": "US",
          "full_address": "7085488 Bradtke Shoal, 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": "c83bc210-d730-481c-b910-acf3656248cb",
            "address1": "7085488 Bradtke Shoal",
            "address2": null,
            "city": "South Jessie",
            "state": "CT",
            "postal": "39384",
            "country": "US",
            "full_address": "7085488 Bradtke Shoal, 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": "fb4c7133-dd91-4856-9cdd-4393df623eef",
        "previous_ledger_ids": [],
        "closed_lead_ids": [
          "eb7f079a-1c38-4367-adf8-c030549fe0c0"
        ],
        "contact_ids": [],
        "support_case_ids": [],
        "event_ids": [
          "61dd671f-00e9-4c4f-a258-0d746dac6d25",
          "f61d2c32-1d75-4b98-9018-39344f7dfd98",
          "79eb7338-25aa-4510-8347-d55e8834677a",
          "a9713e3f-8c9e-4991-9e05-b01738ca8c93"
        ],
        "password_recovery_question_ids": [
          "64315189-e07b-4ff6-8aad-381134d9a494",
          "124702de-765d-4093-a4be-c1521bc3b533"
        ]
      },
      "unit": {
        "id": "0dbbdab7-c3fb-485d-9795-641576b83b14",
        "price": 847.75,
        "name": "U110",
        "description": "",
        "width": 8.0,
        "length": 5.0,
        "height": 7.0,
        "door_height": 10.0,
        "door_width": 2.0,
        "door_type": "roll_up",
        "access_type": "indoor",
        "floor": null,
        "directions": null,
        "size": "8x5x7",
        "area": 40.0,
        "standard_rate": 847.75,
        "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": 2033,
          "descriptor": "No Tier",
          "tiered_amenities": []
        },
        "custom_fields": [],
        "channel_rate": null,
        "unit_amenities": [],
        "unit_type": {
          "id": "a011dd9c-53f2-432a-9571-b17044f089f8",
          "name": "Unit Type 126",
          "deleted": false,
          "internal_account_code": "4000",
          "code_and_description": "4000 - Rental Revenue",
          "ii_excluded": []
        },
        "unit_group_id": "cbd024cf-bf30-4430-b9ad-156c5c52d8d0"
      },
      "length_of_stay": null,
      "successful_payment_events": [],
      "caller_phone_number": null,
      "unit_amenities": [],
      "current_user": null,
      "unit_type": {
        "id": "a011dd9c-53f2-432a-9571-b17044f089f8",
        "name": "Unit Type 126",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "close_reason": null,
      "discount_plans": [],
      "lead_contents": [],
      "unit_group": {
        "id": "cbd024cf-bf30-4430-b9ad-156c5c52d8d0",
        "price": 847.75,
        "group_key": "8x5x7 - $847.75 - 2097",
        "name": "8x5x7 - $847.75 - 2097",
        "available_units_count": 0,
        "total_units_count": 1,
        "total_non_excluded_units_count": 1,
        "size": "8x5x7",
        "standard_rate": 847.75,
        "floor": null,
        "reduced_price": 847.75,
        "cyo_reduced_prices": {},
        "occupancy_percent": 0.0,
        "area": 40.0,
        "length": 5.0,
        "width": 8.0,
        "height": 7.0,
        "due_at_move_in": 847.75,
        "due_at_move_in_without_fees": 847.75,
        "due_monthly": 847.75,
        "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": 2033,
          "descriptor": "No Tier",
          "justification": null,
          "tiered_amenities": []
        },
        "channel_rate": null,
        "unit_amenities": [],
        "unit_type": {
          "id": "a011dd9c-53f2-432a-9571-b17044f089f8",
          "name": "Unit Type 126",
          "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": "c6eeab2e-223f-4517-8cf5-cb436fbc7372",
        "name": "Test App",
        "type": "Source"
      },
      "channel_id": null,
      "confirmation_email": null
    },
    {
      "id": "939cd45e-9bd7-44a3-8398-79fd1ba79fc5",
      "bilingual_agent": false,
      "caller_first_name": null,
      "caller_last_name": null,
      "cancelled_at": null,
      "closed": false,
      "confirmation_number": null,
      "created_at": "2022-09-12T22:37:07.087-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": "fb4c7133-dd91-4856-9cdd-4393df623eef",
      "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": null,
      "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:37:07.087-10:00",
      "status": "created",
      "tenant_id": "1233de69-77ba-4936-a544-c84015b13585",
      "urgent": false,
      "wait_list": false,
      "wait_list_available": false,
      "within_reservation_window": true,
      "is_upgrade": null,
      "desired_unit_size_and_amenities": null,
      "tenant": {
        "id": "1233de69-77ba-4936-a544-c84015b13585",
        "account_number": 1000000,
        "first_name": "Regine134",
        "last_name": "Wehner",
        "middle_initial": null,
        "email": "leilani@grady.io136",
        "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_134",
        "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:37:06.755-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": "c83bc210-d730-481c-b910-acf3656248cb",
          "address1": "7085488 Bradtke Shoal",
          "address2": null,
          "city": "South Jessie",
          "state": "CT",
          "postal": "39384",
          "country": "US",
          "full_address": "7085488 Bradtke Shoal, 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": "c83bc210-d730-481c-b910-acf3656248cb",
            "address1": "7085488 Bradtke Shoal",
            "address2": null,
            "city": "South Jessie",
            "state": "CT",
            "postal": "39384",
            "country": "US",
            "full_address": "7085488 Bradtke Shoal, 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": "fb4c7133-dd91-4856-9cdd-4393df623eef",
        "previous_ledger_ids": [],
        "closed_lead_ids": [
          "eb7f079a-1c38-4367-adf8-c030549fe0c0"
        ],
        "contact_ids": [],
        "support_case_ids": [],
        "event_ids": [
          "61dd671f-00e9-4c4f-a258-0d746dac6d25",
          "f61d2c32-1d75-4b98-9018-39344f7dfd98",
          "79eb7338-25aa-4510-8347-d55e8834677a",
          "a9713e3f-8c9e-4991-9e05-b01738ca8c93"
        ],
        "password_recovery_question_ids": [
          "64315189-e07b-4ff6-8aad-381134d9a494",
          "124702de-765d-4093-a4be-c1521bc3b533"
        ]
      },
      "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": "c6eeab2e-223f-4517-8cf5-cb436fbc7372",
        "name": "Test App",
        "type": "Source"
      },
      "channel_id": null,
      "confirmation_email": null
    },
    {
      "id": "fd477086-98d3-4183-8086-b5176ceb445d",
      "bilingual_agent": false,
      "caller_first_name": null,
      "caller_last_name": null,
      "cancelled_at": null,
      "closed": false,
      "confirmation_number": null,
      "created_at": "2022-09-12T22:37:06.992-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": "fb4c7133-dd91-4856-9cdd-4393df623eef",
      "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": null,
      "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:37:06.992-10:00",
      "status": "created",
      "tenant_id": "1233de69-77ba-4936-a544-c84015b13585",
      "urgent": false,
      "wait_list": false,
      "wait_list_available": false,
      "within_reservation_window": true,
      "is_upgrade": null,
      "desired_unit_size_and_amenities": null,
      "tenant": {
        "id": "1233de69-77ba-4936-a544-c84015b13585",
        "account_number": 1000000,
        "first_name": "Regine134",
        "last_name": "Wehner",
        "middle_initial": null,
        "email": "leilani@grady.io136",
        "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_134",
        "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:37:06.755-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": "c83bc210-d730-481c-b910-acf3656248cb",
          "address1": "7085488 Bradtke Shoal",
          "address2": null,
          "city": "South Jessie",
          "state": "CT",
          "postal": "39384",
          "country": "US",
          "full_address": "7085488 Bradtke Shoal, 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": "c83bc210-d730-481c-b910-acf3656248cb",
            "address1": "7085488 Bradtke Shoal",
            "address2": null,
            "city": "South Jessie",
            "state": "CT",
            "postal": "39384",
            "country": "US",
            "full_address": "7085488 Bradtke Shoal, 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": "fb4c7133-dd91-4856-9cdd-4393df623eef",
        "previous_ledger_ids": [],
        "closed_lead_ids": [
          "eb7f079a-1c38-4367-adf8-c030549fe0c0"
        ],
        "contact_ids": [],
        "support_case_ids": [],
        "event_ids": [
          "61dd671f-00e9-4c4f-a258-0d746dac6d25",
          "f61d2c32-1d75-4b98-9018-39344f7dfd98",
          "79eb7338-25aa-4510-8347-d55e8834677a",
          "a9713e3f-8c9e-4991-9e05-b01738ca8c93"
        ],
        "password_recovery_question_ids": [
          "64315189-e07b-4ff6-8aad-381134d9a494",
          "124702de-765d-4093-a4be-c1521bc3b533"
        ]
      },
      "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": "c6eeab2e-223f-4517-8cf5-cb436fbc7372",
        "name": "Test App",
        "type": "Source"
      },
      "channel_id": null,
      "confirmation_email": null
    },
    {
      "id": "2448248b-8abf-4dd5-9cd9-797801a3c2f8",
      "bilingual_agent": false,
      "caller_first_name": null,
      "caller_last_name": null,
      "cancelled_at": null,
      "closed": false,
      "confirmation_number": null,
      "created_at": "2022-09-12T22:37:06.900-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": "fb4c7133-dd91-4856-9cdd-4393df623eef",
      "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": null,
      "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:37:06.900-10:00",
      "status": "created",
      "tenant_id": "1233de69-77ba-4936-a544-c84015b13585",
      "urgent": false,
      "wait_list": false,
      "wait_list_available": false,
      "within_reservation_window": true,
      "is_upgrade": null,
      "desired_unit_size_and_amenities": null,
      "tenant": {
        "id": "1233de69-77ba-4936-a544-c84015b13585",
        "account_number": 1000000,
        "first_name": "Regine134",
        "last_name": "Wehner",
        "middle_initial": null,
        "email": "leilani@grady.io136",
        "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_134",
        "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:37:06.755-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": "c83bc210-d730-481c-b910-acf3656248cb",
          "address1": "7085488 Bradtke Shoal",
          "address2": null,
          "city": "South Jessie",
          "state": "CT",
          "postal": "39384",
          "country": "US",
          "full_address": "7085488 Bradtke Shoal, 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": "c83bc210-d730-481c-b910-acf3656248cb",
            "address1": "7085488 Bradtke Shoal",
            "address2": null,
            "city": "South Jessie",
            "state": "CT",
            "postal": "39384",
            "country": "US",
            "full_address": "7085488 Bradtke Shoal, 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": "fb4c7133-dd91-4856-9cdd-4393df623eef",
        "previous_ledger_ids": [],
        "closed_lead_ids": [
          "eb7f079a-1c38-4367-adf8-c030549fe0c0"
        ],
        "contact_ids": [],
        "support_case_ids": [],
        "event_ids": [
          "61dd671f-00e9-4c4f-a258-0d746dac6d25",
          "f61d2c32-1d75-4b98-9018-39344f7dfd98",
          "79eb7338-25aa-4510-8347-d55e8834677a",
          "a9713e3f-8c9e-4991-9e05-b01738ca8c93"
        ],
        "password_recovery_question_ids": [
          "64315189-e07b-4ff6-8aad-381134d9a494",
          "124702de-765d-4093-a4be-c1521bc3b533"
        ]
      },
      "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": "c6eeab2e-223f-4517-8cf5-cb436fbc7372",
        "name": "Test App",
        "type": "Source"
      },
      "channel_id": null,
      "confirmation_email": null
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "total_pages": 1,
      "per_page": 100,
      "total_entries": 4,
      "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": "fb4c7133-dd91-4856-9cdd-4393df623eef",
      "tenant_id": "1233de69-77ba-4936-a544-c84015b13585"
    }
  }
}

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>.

GET /v1/:facility_id/tenants/:tenant_id/leads/follow_up
Show all followup 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

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>.

GET /v1/:facility_id/tenants/:tenant_id/leads/reservations
Show all leads that are reservations

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/2e2d6960-572c-4c10-9a12-f170c365dc3f/tenants/bb5cbfb8-399e-46c2-a4d4-29cbc9ad33db/leads/reservations
200
{
  "leads": [
    {
      "id": "884a6911-a39e-4625-840e-bb9013a0c32b",
      "bilingual_agent": false,
      "caller_first_name": null,
      "caller_last_name": null,
      "cancelled_at": null,
      "closed": false,
      "confirmation_number": "1000000-1-1756",
      "created_at": "2022-09-12T22:37:08.423-10:00",
      "desired_move_in_date": "2022-09-15",
      "desired_unit_size_and_price": "8x5x7 at $847.75",
      "due_at_move_in": 452.13,
      "due_monthly": 847.75,
      "extra_details": {
        "snapshot_reservation_id": "64b9cb19-57d7-428e-bf27-dffe75e6b1ed",
        "previous_snapshot_reservation_id": "feeb3209-1690-48b7-af20-47892bd96041"
      },
      "facility_id": "2e2d6960-572c-4c10-9a12-f170c365dc3f",
      "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": null,
      "next_lead_action": null,
      "next_lead_action_index": null,
      "origination": "lead",
      "plant_a_tree": false,
      "quoted_rate": 847.75,
      "rate_type": null,
      "reduced_price": 847.75,
      "reservation_fee_required": null,
      "reservation_window": 0,
      "reserved_at": "2022-09-12T22:37:08.660-10:00",
      "size": "8x5x7",
      "source_id": null,
      "source_name": null,
      "standard_rate": null,
      "started_at": "2022-09-12T22:37:08.423-10:00",
      "status": "reserved",
      "tenant_id": "bb5cbfb8-399e-46c2-a4d4-29cbc9ad33db",
      "urgent": false,
      "wait_list": false,
      "wait_list_available": false,
      "within_reservation_window": true,
      "is_upgrade": null,
      "desired_unit_size_and_amenities": null,
      "tenant": {
        "id": "bb5cbfb8-399e-46c2-a4d4-29cbc9ad33db",
        "account_number": 1000000,
        "first_name": "Jeffrey146",
        "last_name": "Wehner",
        "middle_initial": null,
        "email": "nancy@lueilwitz.com148",
        "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_146",
        "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:37:07.952-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": "b76489cf-2f5e-41ad-98e3-1c9fcc853dc0",
          "address1": "725181 Fahey Pass",
          "address2": null,
          "city": "South Jessie",
          "state": "CT",
          "postal": "39384",
          "country": "US",
          "full_address": "725181 Fahey Pass, 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": "b76489cf-2f5e-41ad-98e3-1c9fcc853dc0",
            "address1": "725181 Fahey Pass",
            "address2": null,
            "city": "South Jessie",
            "state": "CT",
            "postal": "39384",
            "country": "US",
            "full_address": "725181 Fahey Pass, 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": "2e2d6960-572c-4c10-9a12-f170c365dc3f",
        "previous_ledger_ids": [],
        "closed_lead_ids": [
          "7e32a1bf-11da-4f26-8b08-4233888586a0"
        ],
        "contact_ids": [],
        "support_case_ids": [],
        "event_ids": [
          "f4c220cf-5053-448e-944c-fe163e3a3127",
          "30ba9076-86ec-4b30-82c5-1a43d14e1197",
          "f8af73fb-0f8a-4740-8218-d1119456fea0",
          "2fcb2fbb-3da4-4fab-a61a-f18afb437f51"
        ],
        "password_recovery_question_ids": [
          "dd0cb8f6-e3d3-45a3-86aa-6d88f83ec7a7",
          "74a1f6a8-2d47-43d6-88a3-5b9dcb1d2225"
        ]
      },
      "unit": {
        "id": "2b062d48-de69-4efb-9f93-6f90916657d8",
        "price": 847.75,
        "name": "U112",
        "description": "",
        "width": 8.0,
        "length": 5.0,
        "height": 7.0,
        "door_height": 10.0,
        "door_width": 2.0,
        "door_type": "roll_up",
        "access_type": "indoor",
        "floor": null,
        "directions": null,
        "size": "8x5x7",
        "area": 40.0,
        "standard_rate": 847.75,
        "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": 2035,
          "descriptor": "No Tier",
          "tiered_amenities": []
        },
        "custom_fields": [],
        "channel_rate": null,
        "unit_amenities": [],
        "unit_type": {
          "id": "5008c8b4-530d-4033-a0b4-b12b4071dcd4",
          "name": "Unit Type 128",
          "deleted": false,
          "internal_account_code": "4000",
          "code_and_description": "4000 - Rental Revenue",
          "ii_excluded": []
        },
        "unit_group_id": "a7073801-0906-4e79-94f1-352a9ccefdf7"
      },
      "length_of_stay": null,
      "successful_payment_events": [],
      "caller_phone_number": null,
      "unit_amenities": [],
      "current_user": null,
      "unit_type": {
        "id": "5008c8b4-530d-4033-a0b4-b12b4071dcd4",
        "name": "Unit Type 128",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "close_reason": null,
      "discount_plans": [],
      "lead_contents": [],
      "unit_group": {
        "id": "a7073801-0906-4e79-94f1-352a9ccefdf7",
        "price": 847.75,
        "group_key": "8x5x7 - $847.75 - 2099",
        "name": "8x5x7 - $847.75 - 2099",
        "available_units_count": 0,
        "total_units_count": 1,
        "total_non_excluded_units_count": 1,
        "size": "8x5x7",
        "standard_rate": 847.75,
        "floor": null,
        "reduced_price": 847.75,
        "cyo_reduced_prices": {},
        "occupancy_percent": 0.0,
        "area": 40.0,
        "length": 5.0,
        "width": 8.0,
        "height": 7.0,
        "due_at_move_in": 847.75,
        "due_at_move_in_without_fees": 847.75,
        "due_monthly": 847.75,
        "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": 2035,
          "descriptor": "No Tier",
          "justification": null,
          "tiered_amenities": []
        },
        "channel_rate": null,
        "unit_amenities": [],
        "unit_type": {
          "id": "5008c8b4-530d-4033-a0b4-b12b4071dcd4",
          "name": "Unit Type 128",
          "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": "fc4ea7d0-c612-4f66-9c75-ca37e701160a",
        "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": "2e2d6960-572c-4c10-9a12-f170c365dc3f",
      "tenant_id": "bb5cbfb8-399e-46c2-a4d4-29cbc9ad33db"
    }
  }
}

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>.

GET /v1/:facility_id/tenants/:tenant_id/leads/inquiries
Show all leads that are not reservations (inquiries)

You can filter leads by channel category. The field channel has these possible values: system, tenant_portal, sales_center, web, print, other, web_popup

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>.

GET /v1/:facility_id/tenants/:tenant_id/leads/missed_move_ins
Show all missed move ins

You can filter leads by channel category. The field channel has these possible values: system, tenant_portal, sales_center, web, print, other, web_popup

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>.

GET /v1/:facility_id/tenants/:tenant_id/leads/waitlist
Show all waitlist 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

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>.

GET /v1/:facility_id/tenants/:tenant_id/leads/open/events
Shows all lead events for open 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/fa9e0e9a-2769-4824-a0fb-ecd66405f29c/tenants/944a69ff-5436-43ed-826a-0469c1483f8d/leads/open/events
200
{
  "lead_events": [
    {
      "id": "356d8e88-5562-4bf2-b9e2-74a7394c5581",
      "type": "Lead",
      "lead_verb": "reserved",
      "lead_changes": {
        "quoted_rate": [
          null,
          847.75
        ],
        "desired_move_in_date": [
          "2022-09-12",
          "2022-09-15"
        ],
        "unit_id": [
          null,
          2088
        ],
        "status": [
          "created",
          "reserved"
        ]
      },
      "lead_changes_humanized": {
        "Quoted Rate": [
          "--",
          "$847.75"
        ],
        "Desired Move-in Date": [
          "Sep 12th, 2022",
          "Sep 15th, 2022"
        ],
        "Unit": [
          "--",
          "U114"
        ],
        "Status": [
          "Created",
          "Reserved"
        ]
      },
      "lead_action_performed": null,
      "created_at": "2022-09-12T22:37:09.727-10:00",
      "lead_id": "34034920-bed5-4d89-84f4-dbe90088a1e3",
      "selected_action": null,
      "rate_type": null,
      "channel_rate_id": null,
      "tenant": {
        "id": "944a69ff-5436-43ed-826a-0469c1483f8d",
        "account_number": 1000000,
        "first_name": "Kristle158",
        "last_name": "Wehner",
        "middle_initial": null,
        "email": "theodorequigley@bednarwelch.io160",
        "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_158",
        "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:37:09.123-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": "dfb64d67-c256-4ae4-a2b7-dc6085f32f0a",
          "address1": "7425872 Murphy Trace",
          "address2": null,
          "city": "South Jessie",
          "state": "CT",
          "postal": "39384",
          "country": "US",
          "full_address": "7425872 Murphy Trace, 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": "dfb64d67-c256-4ae4-a2b7-dc6085f32f0a",
            "address1": "7425872 Murphy Trace",
            "address2": null,
            "city": "South Jessie",
            "state": "CT",
            "postal": "39384",
            "country": "US",
            "full_address": "7425872 Murphy Trace, 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": "fa9e0e9a-2769-4824-a0fb-ecd66405f29c",
        "previous_ledger_ids": [],
        "lead_ids": [
          "85630433-85eb-4fee-9dcb-a441ae566b05",
          "42cfefa1-b829-4c6b-b46c-b36eebaf8e62",
          "d27ed1bc-7b17-4f95-a5fa-98f72c477f89",
          "34034920-bed5-4d89-84f4-dbe90088a1e3"
        ],
        "closed_lead_ids": [
          "5ddfce97-0fdc-4d82-8483-1cc097e9107c"
        ],
        "contact_ids": [],
        "support_case_ids": [],
        "event_ids": [
          "bf23882d-649b-4afd-a934-95fc7ee94308",
          "356d8e88-5562-4bf2-b9e2-74a7394c5581",
          "a329f3b6-ec5d-4ec3-9de0-c37e71dbae3a",
          "0d87e6e3-56e1-4e77-bbfe-a2859392e884"
        ],
        "password_recovery_question_ids": [
          "85692a66-300c-48db-8571-17b9003cae78",
          "28eb4c56-b139-4423-913f-a09ea7c9a12a"
        ]
      },
      "unit": {
        "id": "33f32da8-d383-41ad-a165-e86c925475f2",
        "price": 847.75,
        "name": "U114",
        "description": "",
        "width": 8.0,
        "length": 5.0,
        "height": 7.0,
        "door_height": 10.0,
        "door_width": 2.0,
        "door_type": "roll_up",
        "access_type": "indoor",
        "floor": null,
        "directions": null,
        "size": "8x5x7",
        "area": 40.0,
        "standard_rate": 847.75,
        "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": 2037,
          "descriptor": "No Tier",
          "tiered_amenities": []
        },
        "custom_fields": [],
        "channel_rate": null,
        "unit_amenities": [],
        "unit_type": {
          "id": "344bf2a3-fb88-4ed6-addf-e0037dd5b4ee",
          "name": "Unit Type 130",
          "deleted": false,
          "internal_account_code": "4000",
          "code_and_description": "4000 - Rental Revenue",
          "ii_excluded": []
        },
        "unit_group_id": "efdf4777-f385-4d86-ba2a-7382a17f4ee7"
      },
      "lead": {
        "id": "34034920-bed5-4d89-84f4-dbe90088a1e3",
        "bilingual_agent": false,
        "caller_first_name": null,
        "caller_last_name": null,
        "cancelled_at": null,
        "closed": false,
        "confirmation_number": "1000000-1-1768",
        "created_at": "2022-09-12T22:37:09.628-10:00",
        "desired_move_in_date": "2022-09-15",
        "desired_unit_size_and_price": "8x5x7 at $847.75",
        "due_at_move_in": 452.13,
        "due_monthly": 847.75,
        "extra_details": {
          "snapshot_reservation_id": "02bbb820-fa12-49f4-92de-ba80d17c750a",
          "previous_snapshot_reservation_id": "a99081f5-7155-48bc-aaac-671e553fa7c9"
        },
        "facility_id": "fa9e0e9a-2769-4824-a0fb-ecd66405f29c",
        "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": null,
        "next_lead_action": null,
        "next_lead_action_index": null,
        "origination": "lead",
        "plant_a_tree": false,
        "quoted_rate": 847.75,
        "rate_type": null,
        "reduced_price": 847.75,
        "reservation_fee_required": null,
        "reservation_window": 0,
        "reserved_at": "2022-09-12T22:37:09.807-10:00",
        "size": "8x5x7",
        "source_id": null,
        "source_name": null,
        "standard_rate": null,
        "started_at": "2022-09-12T22:37:09.628-10:00",
        "status": "reserved",
        "tenant_id": "944a69ff-5436-43ed-826a-0469c1483f8d",
        "urgent": false,
        "wait_list": false,
        "wait_list_available": false,
        "within_reservation_window": true,
        "is_upgrade": null,
        "desired_unit_size_and_amenities": null,
        "tenant": {
          "id": "944a69ff-5436-43ed-826a-0469c1483f8d",
          "account_number": 1000000,
          "first_name": "Kristle158",
          "last_name": "Wehner",
          "middle_initial": null,
          "email": "theodorequigley@bednarwelch.io160",
          "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_158",
          "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:37:09.123-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": "dfb64d67-c256-4ae4-a2b7-dc6085f32f0a",
            "address1": "7425872 Murphy Trace",
            "address2": null,
            "city": "South Jessie",
            "state": "CT",
            "postal": "39384",
            "country": "US",
            "full_address": "7425872 Murphy Trace, 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": "dfb64d67-c256-4ae4-a2b7-dc6085f32f0a",
              "address1": "7425872 Murphy Trace",
              "address2": null,
              "city": "South Jessie",
              "state": "CT",
              "postal": "39384",
              "country": "US",
              "full_address": "7425872 Murphy Trace, 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": "fa9e0e9a-2769-4824-a0fb-ecd66405f29c",
          "previous_ledger_ids": [],
          "closed_lead_ids": [
            "5ddfce97-0fdc-4d82-8483-1cc097e9107c"
          ],
          "contact_ids": [],
          "support_case_ids": [],
          "event_ids": [
            "bf23882d-649b-4afd-a934-95fc7ee94308",
            "356d8e88-5562-4bf2-b9e2-74a7394c5581",
            "a329f3b6-ec5d-4ec3-9de0-c37e71dbae3a",
            "0d87e6e3-56e1-4e77-bbfe-a2859392e884"
          ],
          "password_recovery_question_ids": [
            "85692a66-300c-48db-8571-17b9003cae78",
            "28eb4c56-b139-4423-913f-a09ea7c9a12a"
          ]
        },
        "unit": {
          "id": "33f32da8-d383-41ad-a165-e86c925475f2",
          "price": 847.75,
          "name": "U114",
          "description": "",
          "width": 8.0,
          "length": 5.0,
          "height": 7.0,
          "door_height": 10.0,
          "door_width": 2.0,
          "door_type": "roll_up",
          "access_type": "indoor",
          "floor": null,
          "directions": null,
          "size": "8x5x7",
          "area": 40.0,
          "standard_rate": 847.75,
          "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": 2037,
            "descriptor": "No Tier",
            "tiered_amenities": []
          },
          "custom_fields": [],
          "channel_rate": null,
          "unit_amenities": [],
          "unit_type": {
            "id": "344bf2a3-fb88-4ed6-addf-e0037dd5b4ee",
            "name": "Unit Type 130",
            "deleted": false,
            "internal_account_code": "4000",
            "code_and_description": "4000 - Rental Revenue",
            "ii_excluded": []
          },
          "unit_group_id": "efdf4777-f385-4d86-ba2a-7382a17f4ee7"
        },
        "length_of_stay": null,
        "successful_payment_events": [],
        "caller_phone_number": null,
        "unit_amenities": [],
        "current_user": null,
        "unit_type": {
          "id": "344bf2a3-fb88-4ed6-addf-e0037dd5b4ee",
          "name": "Unit Type 130",
          "deleted": false,
          "internal_account_code": "4000",
          "code_and_description": "4000 - Rental Revenue",
          "ii_excluded": []
        },
        "close_reason": null,
        "discount_plans": [],
        "lead_contents": [],
        "unit_group": {
          "id": "efdf4777-f385-4d86-ba2a-7382a17f4ee7",
          "price": 847.75,
          "group_key": "8x5x7 - $847.75 - 2101",
          "name": "8x5x7 - $847.75 - 2101",
          "available_units_count": 0,
          "total_units_count": 1,
          "total_non_excluded_units_count": 1,
          "size": "8x5x7",
          "standard_rate": 847.75,
          "floor": null,
          "reduced_price": 847.75,
          "cyo_reduced_prices": {},
          "occupancy_percent": 0.0,
          "area": 40.0,
          "length": 5.0,
          "width": 8.0,
          "height": 7.0,
          "due_at_move_in": 847.75,
          "due_at_move_in_without_fees": 847.75,
          "due_monthly": 847.75,
          "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": 2037,
            "descriptor": "No Tier",
            "justification": null,
            "tiered_amenities": []
          },
          "channel_rate": null,
          "unit_amenities": [],
          "unit_type": {
            "id": "344bf2a3-fb88-4ed6-addf-e0037dd5b4ee",
            "name": "Unit Type 130",
            "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": "06337174-87c1-42e4-8ca0-a855cd7974e2",
          "name": "Test App",
          "type": "Source"
        },
        "channel_id": null,
        "confirmation_email": null
      },
      "notes": [],
      "created_by": {
        "id": "96d52f05-e4fb-4e58-99d2-1820b055da42",
        "name": "Test App",
        "type": "ClientApplication"
      },
      "source_id": null
    },
    {
      "id": "bf23882d-649b-4afd-a934-95fc7ee94308",
      "type": "Lead",
      "lead_verb": "updated",
      "lead_changes": {},
      "lead_changes_humanized": {},
      "lead_action_performed": null,
      "created_at": "2022-09-12T22:37:09.999-10:00",
      "lead_id": "34034920-bed5-4d89-84f4-dbe90088a1e3",
      "selected_action": null,
      "rate_type": null,
      "channel_rate_id": null,
      "tenant": {
        "id": "944a69ff-5436-43ed-826a-0469c1483f8d",
        "account_number": 1000000,
        "first_name": "Kristle158",
        "last_name": "Wehner",
        "middle_initial": null,
        "email": "theodorequigley@bednarwelch.io160",
        "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_158",
        "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:37:09.123-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": "dfb64d67-c256-4ae4-a2b7-dc6085f32f0a",
          "address1": "7425872 Murphy Trace",
          "address2": null,
          "city": "South Jessie",
          "state": "CT",
          "postal": "39384",
          "country": "US",
          "full_address": "7425872 Murphy Trace, 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": "dfb64d67-c256-4ae4-a2b7-dc6085f32f0a",
            "address1": "7425872 Murphy Trace",
            "address2": null,
            "city": "South Jessie",
            "state": "CT",
            "postal": "39384",
            "country": "US",
            "full_address": "7425872 Murphy Trace, 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": "fa9e0e9a-2769-4824-a0fb-ecd66405f29c",
        "previous_ledger_ids": [],
        "closed_lead_ids": [
          "5ddfce97-0fdc-4d82-8483-1cc097e9107c"
        ],
        "contact_ids": [],
        "support_case_ids": [],
        "event_ids": [
          "bf23882d-649b-4afd-a934-95fc7ee94308",
          "356d8e88-5562-4bf2-b9e2-74a7394c5581",
          "a329f3b6-ec5d-4ec3-9de0-c37e71dbae3a",
          "0d87e6e3-56e1-4e77-bbfe-a2859392e884"
        ],
        "password_recovery_question_ids": [
          "85692a66-300c-48db-8571-17b9003cae78",
          "28eb4c56-b139-4423-913f-a09ea7c9a12a"
        ]
      },
      "unit": {
        "id": "33f32da8-d383-41ad-a165-e86c925475f2",
        "price": 847.75,
        "name": "U114",
        "description": "",
        "width": 8.0,
        "length": 5.0,
        "height": 7.0,
        "door_height": 10.0,
        "door_width": 2.0,
        "door_type": "roll_up",
        "access_type": "indoor",
        "floor": null,
        "directions": null,
        "size": "8x5x7",
        "area": 40.0,
        "standard_rate": 847.75,
        "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": 2037,
          "descriptor": "No Tier",
          "tiered_amenities": []
        },
        "custom_fields": [],
        "channel_rate": null,
        "unit_amenities": [],
        "unit_type": {
          "id": "344bf2a3-fb88-4ed6-addf-e0037dd5b4ee",
          "name": "Unit Type 130",
          "deleted": false,
          "internal_account_code": "4000",
          "code_and_description": "4000 - Rental Revenue",
          "ii_excluded": []
        },
        "unit_group_id": "efdf4777-f385-4d86-ba2a-7382a17f4ee7"
      },
      "lead": {
        "id": "34034920-bed5-4d89-84f4-dbe90088a1e3",
        "bilingual_agent": false,
        "caller_first_name": null,
        "caller_last_name": null,
        "cancelled_at": null,
        "closed": false,
        "confirmation_number": "1000000-1-1768",
        "created_at": "2022-09-12T22:37:09.628-10:00",
        "desired_move_in_date": "2022-09-15",
        "desired_unit_size_and_price": "8x5x7 at $847.75",
        "due_at_move_in": 452.13,
        "due_monthly": 847.75,
        "extra_details": {
          "snapshot_reservation_id": "02bbb820-fa12-49f4-92de-ba80d17c750a",
          "previous_snapshot_reservation_id": "a99081f5-7155-48bc-aaac-671e553fa7c9"
        },
        "facility_id": "fa9e0e9a-2769-4824-a0fb-ecd66405f29c",
        "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": null,
        "next_lead_action": null,
        "next_lead_action_index": null,
        "origination": "lead",
        "plant_a_tree": false,
        "quoted_rate": 847.75,
        "rate_type": null,
        "reduced_price": 847.75,
        "reservation_fee_required": null,
        "reservation_window": 0,
        "reserved_at": "2022-09-12T22:37:09.807-10:00",
        "size": "8x5x7",
        "source_id": null,
        "source_name": null,
        "standard_rate": null,
        "started_at": "2022-09-12T22:37:09.628-10:00",
        "status": "reserved",
        "tenant_id": "944a69ff-5436-43ed-826a-0469c1483f8d",
        "urgent": false,
        "wait_list": false,
        "wait_list_available": false,
        "within_reservation_window": true,
        "is_upgrade": null,
        "desired_unit_size_and_amenities": null,
        "tenant": {
          "id": "944a69ff-5436-43ed-826a-0469c1483f8d",
          "account_number": 1000000,
          "first_name": "Kristle158",
          "last_name": "Wehner",
          "middle_initial": null,
          "email": "theodorequigley@bednarwelch.io160",
          "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_158",
          "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:37:09.123-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": "dfb64d67-c256-4ae4-a2b7-dc6085f32f0a",
            "address1": "7425872 Murphy Trace",
            "address2": null,
            "city": "South Jessie",
            "state": "CT",
            "postal": "39384",
            "country": "US",
            "full_address": "7425872 Murphy Trace, 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": "dfb64d67-c256-4ae4-a2b7-dc6085f32f0a",
              "address1": "7425872 Murphy Trace",
              "address2": null,
              "city": "South Jessie",
              "state": "CT",
              "postal": "39384",
              "country": "US",
              "full_address": "7425872 Murphy Trace, 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": "fa9e0e9a-2769-4824-a0fb-ecd66405f29c",
          "previous_ledger_ids": [],
          "closed_lead_ids": [
            "5ddfce97-0fdc-4d82-8483-1cc097e9107c"
          ],
          "contact_ids": [],
          "support_case_ids": [],
          "event_ids": [
            "bf23882d-649b-4afd-a934-95fc7ee94308",
            "356d8e88-5562-4bf2-b9e2-74a7394c5581",
            "a329f3b6-ec5d-4ec3-9de0-c37e71dbae3a",
            "0d87e6e3-56e1-4e77-bbfe-a2859392e884"
          ],
          "password_recovery_question_ids": [
            "85692a66-300c-48db-8571-17b9003cae78",
            "28eb4c56-b139-4423-913f-a09ea7c9a12a"
          ]
        },
        "unit": {
          "id": "33f32da8-d383-41ad-a165-e86c925475f2",
          "price": 847.75,
          "name": "U114",
          "description": "",
          "width": 8.0,
          "length": 5.0,
          "height": 7.0,
          "door_height": 10.0,
          "door_width": 2.0,
          "door_type": "roll_up",
          "access_type": "indoor",
          "floor": null,
          "directions": null,
          "size": "8x5x7",
          "area": 40.0,
          "standard_rate": 847.75,
          "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": 2037,
            "descriptor": "No Tier",
            "tiered_amenities": []
          },
          "custom_fields": [],
          "channel_rate": null,
          "unit_amenities": [],
          "unit_type": {
            "id": "344bf2a3-fb88-4ed6-addf-e0037dd5b4ee",
            "name": "Unit Type 130",
            "deleted": false,
            "internal_account_code": "4000",
            "code_and_description": "4000 - Rental Revenue",
            "ii_excluded": []
          },
          "unit_group_id": "efdf4777-f385-4d86-ba2a-7382a17f4ee7"
        },
        "length_of_stay": null,
        "successful_payment_events": [],
        "caller_phone_number": null,
        "unit_amenities": [],
        "current_user": null,
        "unit_type": {
          "id": "344bf2a3-fb88-4ed6-addf-e0037dd5b4ee",
          "name": "Unit Type 130",
          "deleted": false,
          "internal_account_code": "4000",
          "code_and_description": "4000 - Rental Revenue",
          "ii_excluded": []
        },
        "close_reason": null,
        "discount_plans": [],
        "lead_contents": [],
        "unit_group": {
          "id": "efdf4777-f385-4d86-ba2a-7382a17f4ee7",
          "price": 847.75,
          "group_key": "8x5x7 - $847.75 - 2101",
          "name": "8x5x7 - $847.75 - 2101",
          "available_units_count": 0,
          "total_units_count": 1,
          "total_non_excluded_units_count": 1,
          "size": "8x5x7",
          "standard_rate": 847.75,
          "floor": null,
          "reduced_price": 847.75,
          "cyo_reduced_prices": {},
          "occupancy_percent": 0.0,
          "area": 40.0,
          "length": 5.0,
          "width": 8.0,
          "height": 7.0,
          "due_at_move_in": 847.75,
          "due_at_move_in_without_fees": 847.75,
          "due_monthly": 847.75,
          "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": 2037,
            "descriptor": "No Tier",
            "justification": null,
            "tiered_amenities": []
          },
          "channel_rate": null,
          "unit_amenities": [],
          "unit_type": {
            "id": "344bf2a3-fb88-4ed6-addf-e0037dd5b4ee",
            "name": "Unit Type 130",
            "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": "06337174-87c1-42e4-8ca0-a855cd7974e2",
          "name": "Test App",
          "type": "Source"
        },
        "channel_id": null,
        "confirmation_email": null
      },
      "notes": [],
      "created_by": {
        "id": "96d52f05-e4fb-4e58-99d2-1820b055da42",
        "name": "Test App",
        "type": "ClientApplication"
      },
      "source_id": null
    },
    {
      "id": "a329f3b6-ec5d-4ec3-9de0-c37e71dbae3a",
      "type": "Lead",
      "lead_verb": "updated",
      "lead_changes": {},
      "lead_changes_humanized": {},
      "lead_action_performed": null,
      "created_at": "2022-09-12T22:37:09.527-10:00",
      "lead_id": "d27ed1bc-7b17-4f95-a5fa-98f72c477f89",
      "selected_action": null,
      "rate_type": null,
      "channel_rate_id": null,
      "tenant": {
        "id": "944a69ff-5436-43ed-826a-0469c1483f8d",
        "account_number": 1000000,
        "first_name": "Kristle158",
        "last_name": "Wehner",
        "middle_initial": null,
        "email": "theodorequigley@bednarwelch.io160",
        "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_158",
        "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:37:09.123-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": "dfb64d67-c256-4ae4-a2b7-dc6085f32f0a",
          "address1": "7425872 Murphy Trace",
          "address2": null,
          "city": "South Jessie",
          "state": "CT",
          "postal": "39384",
          "country": "US",
          "full_address": "7425872 Murphy Trace, 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": "dfb64d67-c256-4ae4-a2b7-dc6085f32f0a",
            "address1": "7425872 Murphy Trace",
            "address2": null,
            "city": "South Jessie",
            "state": "CT",
            "postal": "39384",
            "country": "US",
            "full_address": "7425872 Murphy Trace, 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": "fa9e0e9a-2769-4824-a0fb-ecd66405f29c",
        "previous_ledger_ids": [],
        "closed_lead_ids": [
          "5ddfce97-0fdc-4d82-8483-1cc097e9107c"
        ],
        "contact_ids": [],
        "support_case_ids": [],
        "event_ids": [
          "bf23882d-649b-4afd-a934-95fc7ee94308",
          "356d8e88-5562-4bf2-b9e2-74a7394c5581",
          "a329f3b6-ec5d-4ec3-9de0-c37e71dbae3a",
          "0d87e6e3-56e1-4e77-bbfe-a2859392e884"
        ],
        "password_recovery_question_ids": [
          "85692a66-300c-48db-8571-17b9003cae78",
          "28eb4c56-b139-4423-913f-a09ea7c9a12a"
        ]
      },
      "unit": null,
      "lead": {
        "id": "d27ed1bc-7b17-4f95-a5fa-98f72c477f89",
        "bilingual_agent": false,
        "caller_first_name": null,
        "caller_last_name": null,
        "cancelled_at": null,
        "closed": false,
        "confirmation_number": null,
        "created_at": "2022-09-12T22:37:09.505-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": "fa9e0e9a-2769-4824-a0fb-ecd66405f29c",
        "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": null,
        "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:37:09.505-10:00",
        "status": "created",
        "tenant_id": "944a69ff-5436-43ed-826a-0469c1483f8d",
        "urgent": false,
        "wait_list": false,
        "wait_list_available": false,
        "within_reservation_window": true,
        "is_upgrade": null,
        "desired_unit_size_and_amenities": null,
        "tenant": {
          "id": "944a69ff-5436-43ed-826a-0469c1483f8d",
          "account_number": 1000000,
          "first_name": "Kristle158",
          "last_name": "Wehner",
          "middle_initial": null,
          "email": "theodorequigley@bednarwelch.io160",
          "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_158",
          "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:37:09.123-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": "dfb64d67-c256-4ae4-a2b7-dc6085f32f0a",
            "address1": "7425872 Murphy Trace",
            "address2": null,
            "city": "South Jessie",
            "state": "CT",
            "postal": "39384",
            "country": "US",
            "full_address": "7425872 Murphy Trace, 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": "dfb64d67-c256-4ae4-a2b7-dc6085f32f0a",
              "address1": "7425872 Murphy Trace",
              "address2": null,
              "city": "South Jessie",
              "state": "CT",
              "postal": "39384",
              "country": "US",
              "full_address": "7425872 Murphy Trace, 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": "fa9e0e9a-2769-4824-a0fb-ecd66405f29c",
          "previous_ledger_ids": [],
          "closed_lead_ids": [
            "5ddfce97-0fdc-4d82-8483-1cc097e9107c"
          ],
          "contact_ids": [],
          "support_case_ids": [],
          "event_ids": [
            "bf23882d-649b-4afd-a934-95fc7ee94308",
            "356d8e88-5562-4bf2-b9e2-74a7394c5581",
            "a329f3b6-ec5d-4ec3-9de0-c37e71dbae3a",
            "0d87e6e3-56e1-4e77-bbfe-a2859392e884"
          ],
          "password_recovery_question_ids": [
            "85692a66-300c-48db-8571-17b9003cae78",
            "28eb4c56-b139-4423-913f-a09ea7c9a12a"
          ]
        },
        "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": "06337174-87c1-42e4-8ca0-a855cd7974e2",
          "name": "Test App",
          "type": "Source"
        },
        "channel_id": null,
        "confirmation_email": null
      },
      "notes": [],
      "created_by": {
        "id": "96d52f05-e4fb-4e58-99d2-1820b055da42",
        "name": "Test App",
        "type": "ClientApplication"
      },
      "source_id": null
    },
    {
      "id": "0d87e6e3-56e1-4e77-bbfe-a2859392e884",
      "type": "Lead",
      "lead_verb": "updated",
      "lead_changes": {},
      "lead_changes_humanized": {},
      "lead_action_performed": null,
      "created_at": "2022-09-12T22:37:09.431-10:00",
      "lead_id": "42cfefa1-b829-4c6b-b46c-b36eebaf8e62",
      "selected_action": null,
      "rate_type": null,
      "channel_rate_id": null,
      "tenant": {
        "id": "944a69ff-5436-43ed-826a-0469c1483f8d",
        "account_number": 1000000,
        "first_name": "Kristle158",
        "last_name": "Wehner",
        "middle_initial": null,
        "email": "theodorequigley@bednarwelch.io160",
        "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_158",
        "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:37:09.123-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": "dfb64d67-c256-4ae4-a2b7-dc6085f32f0a",
          "address1": "7425872 Murphy Trace",
          "address2": null,
          "city": "South Jessie",
          "state": "CT",
          "postal": "39384",
          "country": "US",
          "full_address": "7425872 Murphy Trace, 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": "dfb64d67-c256-4ae4-a2b7-dc6085f32f0a",
            "address1": "7425872 Murphy Trace",
            "address2": null,
            "city": "South Jessie",
            "state": "CT",
            "postal": "39384",
            "country": "US",
            "full_address": "7425872 Murphy Trace, 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": "fa9e0e9a-2769-4824-a0fb-ecd66405f29c",
        "previous_ledger_ids": [],
        "closed_lead_ids": [
          "5ddfce97-0fdc-4d82-8483-1cc097e9107c"
        ],
        "contact_ids": [],
        "support_case_ids": [],
        "event_ids": [
          "bf23882d-649b-4afd-a934-95fc7ee94308",
          "356d8e88-5562-4bf2-b9e2-74a7394c5581",
          "a329f3b6-ec5d-4ec3-9de0-c37e71dbae3a",
          "0d87e6e3-56e1-4e77-bbfe-a2859392e884"
        ],
        "password_recovery_question_ids": [
          "85692a66-300c-48db-8571-17b9003cae78",
          "28eb4c56-b139-4423-913f-a09ea7c9a12a"
        ]
      },
      "unit": null,
      "lead": {
        "id": "42cfefa1-b829-4c6b-b46c-b36eebaf8e62",
        "bilingual_agent": false,
        "caller_first_name": null,
        "caller_last_name": null,
        "cancelled_at": null,
        "closed": false,
        "confirmation_number": null,
        "created_at": "2022-09-12T22:37:09.412-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": "fa9e0e9a-2769-4824-a0fb-ecd66405f29c",
        "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": null,
        "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:37:09.412-10:00",
        "status": "created",
        "tenant_id": "944a69ff-5436-43ed-826a-0469c1483f8d",
        "urgent": false,
        "wait_list": false,
        "wait_list_available": false,
        "within_reservation_window": true,
        "is_upgrade": null,
        "desired_unit_size_and_amenities": null,
        "tenant": {
          "id": "944a69ff-5436-43ed-826a-0469c1483f8d",
          "account_number": 1000000,
          "first_name": "Kristle158",
          "last_name": "Wehner",
          "middle_initial": null,
          "email": "theodorequigley@bednarwelch.io160",
          "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_158",
          "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:37:09.123-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": "dfb64d67-c256-4ae4-a2b7-dc6085f32f0a",
            "address1": "7425872 Murphy Trace",
            "address2": null,
            "city": "South Jessie",
            "state": "CT",
            "postal": "39384",
            "country": "US",
            "full_address": "7425872 Murphy Trace, 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": "dfb64d67-c256-4ae4-a2b7-dc6085f32f0a",
              "address1": "7425872 Murphy Trace",
              "address2": null,
              "city": "South Jessie",
              "state": "CT",
              "postal": "39384",
              "country": "US",
              "full_address": "7425872 Murphy Trace, 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": "fa9e0e9a-2769-4824-a0fb-ecd66405f29c",
          "previous_ledger_ids": [],
          "closed_lead_ids": [
            "5ddfce97-0fdc-4d82-8483-1cc097e9107c"
          ],
          "contact_ids": [],
          "support_case_ids": [],
          "event_ids": [
            "bf23882d-649b-4afd-a934-95fc7ee94308",
            "356d8e88-5562-4bf2-b9e2-74a7394c5581",
            "a329f3b6-ec5d-4ec3-9de0-c37e71dbae3a",
            "0d87e6e3-56e1-4e77-bbfe-a2859392e884"
          ],
          "password_recovery_question_ids": [
            "85692a66-300c-48db-8571-17b9003cae78",
            "28eb4c56-b139-4423-913f-a09ea7c9a12a"
          ]
        },
        "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": "06337174-87c1-42e4-8ca0-a855cd7974e2",
          "name": "Test App",
          "type": "Source"
        },
        "channel_id": null,
        "confirmation_email": null
      },
      "notes": [],
      "created_by": {
        "id": "96d52f05-e4fb-4e58-99d2-1820b055da42",
        "name": "Test App",
        "type": "ClientApplication"
      },
      "source_id": null
    },
    {
      "id": "d96a1404-dded-4f34-91d4-1ee2b4c408e2",
      "type": "Lead",
      "lead_verb": "updated",
      "lead_changes": {},
      "lead_changes_humanized": {},
      "lead_action_performed": null,
      "created_at": "2022-09-12T22:37:09.339-10:00",
      "lead_id": "85630433-85eb-4fee-9dcb-a441ae566b05",
      "selected_action": null,
      "rate_type": null,
      "channel_rate_id": null,
      "tenant": {
        "id": "944a69ff-5436-43ed-826a-0469c1483f8d",
        "account_number": 1000000,
        "first_name": "Kristle158",
        "last_name": "Wehner",
        "middle_initial": null,
        "email": "theodorequigley@bednarwelch.io160",
        "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_158",
        "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:37:09.123-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": "dfb64d67-c256-4ae4-a2b7-dc6085f32f0a",
          "address1": "7425872 Murphy Trace",
          "address2": null,
          "city": "South Jessie",
          "state": "CT",
          "postal": "39384",
          "country": "US",
          "full_address": "7425872 Murphy Trace, 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": "dfb64d67-c256-4ae4-a2b7-dc6085f32f0a",
            "address1": "7425872 Murphy Trace",
            "address2": null,
            "city": "South Jessie",
            "state": "CT",
            "postal": "39384",
            "country": "US",
            "full_address": "7425872 Murphy Trace, 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": "fa9e0e9a-2769-4824-a0fb-ecd66405f29c",
        "previous_ledger_ids": [],
        "closed_lead_ids": [
          "5ddfce97-0fdc-4d82-8483-1cc097e9107c"
        ],
        "contact_ids": [],
        "support_case_ids": [],
        "event_ids": [
          "bf23882d-649b-4afd-a934-95fc7ee94308",
          "356d8e88-5562-4bf2-b9e2-74a7394c5581",
          "a329f3b6-ec5d-4ec3-9de0-c37e71dbae3a",
          "0d87e6e3-56e1-4e77-bbfe-a2859392e884"
        ],
        "password_recovery_question_ids": [
          "85692a66-300c-48db-8571-17b9003cae78",
          "28eb4c56-b139-4423-913f-a09ea7c9a12a"
        ]
      },
      "unit": null,
      "lead": {
        "id": "85630433-85eb-4fee-9dcb-a441ae566b05",
        "bilingual_agent": false,
        "caller_first_name": null,
        "caller_last_name": null,
        "cancelled_at": null,
        "closed": false,
        "confirmation_number": null,
        "created_at": "2022-09-12T22:37:09.321-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": "fa9e0e9a-2769-4824-a0fb-ecd66405f29c",
        "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": null,
        "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:37:09.321-10:00",
        "status": "created",
        "tenant_id": "944a69ff-5436-43ed-826a-0469c1483f8d",
        "urgent": false,
        "wait_list": false,
        "wait_list_available": false,
        "within_reservation_window": true,
        "is_upgrade": null,
        "desired_unit_size_and_amenities": null,
        "tenant": {
          "id": "944a69ff-5436-43ed-826a-0469c1483f8d",
          "account_number": 1000000,
          "first_name": "Kristle158",
          "last_name": "Wehner",
          "middle_initial": null,
          "email": "theodorequigley@bednarwelch.io160",
          "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_158",
          "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:37:09.123-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": "dfb64d67-c256-4ae4-a2b7-dc6085f32f0a",
            "address1": "7425872 Murphy Trace",
            "address2": null,
            "city": "South Jessie",
            "state": "CT",
            "postal": "39384",
            "country": "US",
            "full_address": "7425872 Murphy Trace, 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": "dfb64d67-c256-4ae4-a2b7-dc6085f32f0a",
              "address1": "7425872 Murphy Trace",
              "address2": null,
              "city": "South Jessie",
              "state": "CT",
              "postal": "39384",
              "country": "US",
              "full_address": "7425872 Murphy Trace, 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": "fa9e0e9a-2769-4824-a0fb-ecd66405f29c",
          "previous_ledger_ids": [],
          "closed_lead_ids": [
            "5ddfce97-0fdc-4d82-8483-1cc097e9107c"
          ],
          "contact_ids": [],
          "support_case_ids": [],
          "event_ids": [
            "bf23882d-649b-4afd-a934-95fc7ee94308",
            "356d8e88-5562-4bf2-b9e2-74a7394c5581",
            "a329f3b6-ec5d-4ec3-9de0-c37e71dbae3a",
            "0d87e6e3-56e1-4e77-bbfe-a2859392e884"
          ],
          "password_recovery_question_ids": [
            "85692a66-300c-48db-8571-17b9003cae78",
            "28eb4c56-b139-4423-913f-a09ea7c9a12a"
          ]
        },
        "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": "06337174-87c1-42e4-8ca0-a855cd7974e2",
          "name": "Test App",
          "type": "Source"
        },
        "channel_id": null,
        "confirmation_email": null
      },
      "notes": [],
      "created_by": {
        "id": "96d52f05-e4fb-4e58-99d2-1820b055da42",
        "name": "Test App",
        "type": "ClientApplication"
      },
      "source_id": null
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "total_pages": 1,
      "per_page": 100,
      "total_entries": 5,
      "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": "fa9e0e9a-2769-4824-a0fb-ecd66405f29c",
      "tenant_id": "944a69ff-5436-43ed-826a-0469c1483f8d"
    }
  }
}

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>.

GET /v1/:facility_id/tenants/:tenant_id/leads/counts
Shows a count of open leads by status (lead, reservation)

You can filter leads by channel category. The field channel has these possible values: system, tenant_portal, sales_center, web, print, other, web_popup

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>.

GET /v1/:facility_id/tenants/:tenant_id/leads/:id
Show a particular lead

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/40a1099f-6c75-44d3-87c0-e66ff015693d/tenants/9174ea93-002e-41a4-a8ce-2a7e2a884baf/leads/56130c64-2174-4b08-a5a1-4b283f2dc609
200
{
  "lead": {
    "id": "56130c64-2174-4b08-a5a1-4b283f2dc609",
    "bilingual_agent": false,
    "caller_first_name": null,
    "caller_last_name": null,
    "cancelled_at": null,
    "closed": false,
    "confirmation_number": "1000000-1-1792",
    "created_at": "2022-09-12T22:37:12.562-10:00",
    "desired_move_in_date": "2022-09-15",
    "desired_unit_size_and_price": "8x5x7 at $847.75",
    "due_at_move_in": 452.13,
    "due_monthly": 847.75,
    "extra_details": {
      "snapshot_reservation_id": "0680a43a-27eb-4a6a-981b-bf1c9b03798b",
      "previous_snapshot_reservation_id": "2b5cc768-8408-4a6f-90db-d2a544a09eed"
    },
    "facility_id": "40a1099f-6c75-44d3-87c0-e66ff015693d",
    "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": null,
    "next_lead_action": null,
    "next_lead_action_index": null,
    "origination": "lead",
    "plant_a_tree": false,
    "quoted_rate": 847.75,
    "rate_type": null,
    "reduced_price": 847.75,
    "reservation_fee_required": null,
    "reservation_window": 0,
    "reserved_at": "2022-09-12T22:37:12.750-10:00",
    "size": "8x5x7",
    "source_id": null,
    "source_name": null,
    "standard_rate": null,
    "started_at": "2022-09-12T22:37:12.562-10:00",
    "status": "reserved",
    "tenant_id": "9174ea93-002e-41a4-a8ce-2a7e2a884baf",
    "urgent": false,
    "wait_list": false,
    "wait_list_available": false,
    "within_reservation_window": true,
    "is_upgrade": null,
    "desired_unit_size_and_amenities": null,
    "tenant": {
      "id": "9174ea93-002e-41a4-a8ce-2a7e2a884baf",
      "account_number": 1000000,
      "first_name": "Maryland182",
      "last_name": "Wehner",
      "middle_initial": null,
      "email": "marleenlowe@goyette.name184",
      "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_182",
      "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:37:12.073-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": "95462a04-03ed-46f3-b11c-11a93988bf42",
        "address1": "776623 Nannie Lock",
        "address2": null,
        "city": "South Jessie",
        "state": "CT",
        "postal": "39384",
        "country": "US",
        "full_address": "776623 Nannie Lock, 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": "95462a04-03ed-46f3-b11c-11a93988bf42",
          "address1": "776623 Nannie Lock",
          "address2": null,
          "city": "South Jessie",
          "state": "CT",
          "postal": "39384",
          "country": "US",
          "full_address": "776623 Nannie Lock, 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": "40a1099f-6c75-44d3-87c0-e66ff015693d",
      "previous_ledger_ids": [],
      "closed_lead_ids": [
        "6c405cca-5988-4482-8849-c4b85611b09c"
      ],
      "contact_ids": [],
      "support_case_ids": [],
      "event_ids": [
        "c2fd8a9e-f15f-435e-98d6-c42141679f9a",
        "36f0ef11-526d-4d28-85b6-8008e35ade47",
        "d00dc268-6c93-4141-ab4d-03b42ab999de",
        "0a6215b4-d18b-4384-baec-11c4f57c691a"
      ],
      "password_recovery_question_ids": [
        "6345498e-7bcb-44e5-a177-185a2bc7d4ac",
        "b87632ff-f60c-49f2-aaee-0a97fdc86789"
      ]
    },
    "unit": {
      "id": "a468355c-d9e1-4f85-ae97-d6bcc3585f0f",
      "price": 847.75,
      "name": "U118",
      "description": "",
      "width": 8.0,
      "length": 5.0,
      "height": 7.0,
      "door_height": 10.0,
      "door_width": 2.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "8x5x7",
      "area": 40.0,
      "standard_rate": 847.75,
      "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": 2041,
        "descriptor": "No Tier",
        "tiered_amenities": []
      },
      "custom_fields": [],
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "2e7dc820-4849-4c5c-b2ff-b8e36f6f6200",
        "name": "Unit Type 134",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "unit_group_id": "cb5e5cfb-2235-49b1-8c1b-3047f48129ab"
    },
    "length_of_stay": null,
    "successful_payment_events": [],
    "caller_phone_number": null,
    "unit_amenities": [],
    "current_user": null,
    "unit_type": {
      "id": "2e7dc820-4849-4c5c-b2ff-b8e36f6f6200",
      "name": "Unit Type 134",
      "deleted": false,
      "internal_account_code": "4000",
      "code_and_description": "4000 - Rental Revenue",
      "ii_excluded": []
    },
    "close_reason": null,
    "discount_plans": [],
    "lead_contents": [],
    "unit_group": {
      "id": "cb5e5cfb-2235-49b1-8c1b-3047f48129ab",
      "price": 847.75,
      "group_key": "8x5x7 - $847.75 - 2105",
      "name": "8x5x7 - $847.75 - 2105",
      "available_units_count": 0,
      "total_units_count": 1,
      "total_non_excluded_units_count": 1,
      "size": "8x5x7",
      "standard_rate": 847.75,
      "floor": null,
      "reduced_price": 847.75,
      "cyo_reduced_prices": {},
      "occupancy_percent": 0.0,
      "area": 40.0,
      "length": 5.0,
      "width": 8.0,
      "height": 7.0,
      "due_at_move_in": 847.75,
      "due_at_move_in_without_fees": 847.75,
      "due_monthly": 847.75,
      "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": 2041,
        "descriptor": "No Tier",
        "justification": null,
        "tiered_amenities": []
      },
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "2e7dc820-4849-4c5c-b2ff-b8e36f6f6200",
        "name": "Unit Type 134",
        "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": "ed7dd150-64c9-4659-b6d8-bfc89d44848f",
      "name": "Test App",
      "type": "Source"
    },
    "channel_id": null,
    "confirmation_email": null
  },
  "meta": {
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "GET",
    "request_id": null,
    "parameters": {
      "facility_id": "40a1099f-6c75-44d3-87c0-e66ff015693d",
      "tenant_id": "9174ea93-002e-41a4-a8ce-2a7e2a884baf",
      "id": "56130c64-2174-4b08-a5a1-4b283f2dc609"
    }
  }
}

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>.
id
required

Value: Must be a String

POST /v1/:facility_id/tenants/leads/rent_now
Create a tenant with one or more rent-now reservations

This API enables creating Rent-now reservations for facilities that support this feature.

It sets the rent_now attribute to true and the desired_move_in_date to the current date.

Prerequisites

  • flipper_fms_rent_now must be enabled for the facility or else the request will fail
  • is_reservation must be set to true
  • unit_group_id must be provided

Sample error responses

  • 400 for flipper_fms_rent_now not enabled

{
"statuscode": 400,
"status
message": "Bad Request",
"message": "Rent-now reservations are not available for this store."
}
* 400 for is_reservation not set to true

{
"statuscode": 400,
"status
message": "Bad Request",
"message": "is_reservation must be true when creating a rent-now reservation"
}

Params

Param name Description
first_name
required

Value: Must be a String
last_name
optional

Value: Must be a String
email
optional

Value: Must be a String
is_business
optional

True if the tenant record is a commercial entity.


Value: Must be one of: <code>true</code>, <code>false</code>.
phone_numbers_attributes
required

A collection of phone numbers. At least one is required.


Value: Must be an Array of nested elements
phone_numbers_attributes[number]
required

Phone number


Value: Must be a String
phone_numbers_attributes[extension]
optional

Phone number extension


Value: Must be a String
phone_numbers_attributes[label]
optional

A label for what the phone number is, such as Home, Work, Mobile, etc.


Value: Must be a String
phone_numbers_attributes[sms_opt_in]
optional

Opt the tenant in to SMS (if applicable). Requires a "Mobile" label for SMS to work correctly.


Value: Must be one of: <code>true</code>, <code>false</code>.
mailing_address_attributes
optional

Value: Must be a Hash
mailing_address_attributes[address1]
optional

Value: Must be a String
mailing_address_attributes[address2]
optional

Value: Must be a String
mailing_address_attributes[city]
optional

Value: Must be a String
mailing_address_attributes[state]
optional

Value: Must be a String
mailing_address_attributes[postal]
optional

Value: Must be a String
mailing_address_attributes[time_zone]
optional

Valid IANA timezone identifier of the address (see http://www.iana.org/time-zones)


Value: Must be a String
leads_attributes
required

Value: Must be an Array of nested elements
leads_attributes[unit_id]
optional

The ID of the unit to reserve. Required if is_reservation is true. Will be ignored if not in the same unit group as the given unit_group_id or unit's existing unit group.


Value: Must be a String
leads_attributes[unit_group_id]
optional

The ID of the unit group to reserve (the first available unit will be selected).


Value: Must be a String
leads_attributes[id]
optional

The ID of the lead (update only).


Value: Must be a String
leads_attributes[is_reservation]
required

Is the lead a reservation?


Value: Must be one of: <code>true</code>, <code>false</code>.
leads_attributes[caller_first_name]
optional

First name of the caller, if different from the tenant


Value: Must be a String
leads_attributes[caller_last_name]
optional

Last name of the caller, if different from the tenant


Value: Must be a String
leads_attributes[urgent]
optional

Value: Must be one of: <code>true</code>, <code>false</code>.
leads_attributes[quoted_rate]
optional

Value: Must be a String
leads_attributes[length_of_stay_id]
optional

The ID of the length of stay for the lead. You can get a list of length of stays from the company configuration.


Value: Must be a String
leads_attributes[size]
optional

Value: Must be a String
leads_attributes[floor]
optional

Value: Must be a String
leads_attributes[lead_contents]
optional

A collection of marketing content.


Value: Must be an Array of nested elements
leads_attributes[lead_contents][id]
optional

The ID of the marketing content for the lead. You can get a list of contents from the company configuration.


Value: Must be a String
leads_attributes[desired_move_in_date]
optional

Format: YYYY-MM-DD


Value: Must be a Date
leads_attributes[desired_unit_size_and_price]
optional

A String representing the size and price that the user is interested in. Get the possible options from the GET /unit_groups resource.


Value: Must be a String
leads_attributes[free_truck]
optional

Interested in a free truck


Value: Must be one of: <code>true</code>, <code>false</code>.
leads_attributes[moving_labor]
optional

Interested in having help with moving


Value: Must be one of: <code>true</code>, <code>false</code>.
leads_attributes[call_source]
optional

Where the call was initiated from


Value: Must be a String
leads_attributes[dnis]
optional

An identifier for the facility the lead was trying to reach - see http://en.wikipedia.org/wiki/Dialed_Number_Identification_Service


Value: Must be a String
leads_attributes[close_reason_id]
optional

The ID of the reason for closing the lead. You can get a list of reasons from the company configuration.


Value: Must be a String
leads_attributes[lead_action_performed]
optional

The kind of action that was performed on the lead


Value: Must be one of: <code>call</code>, <code>email</code>, <code>text</code>.
leads_attributes[lead_action_performed_index]
optional

The numeric value for the action performed (i.e. if this was the second call a "2" would be used)


Value: Must be a Integer
leads_attributes[next_lead_action]
optional

The kind of follow up action that will be performed


Value: Must be one of: <code>call</code>, <code>email</code>, <code>text</code>.
leads_attributes[notes_attributes]
optional

A collection of notes.


Value: Must be an Array of nested elements
leads_attributes[notes_attributes][note]
required

Note body - freeform text


Value: Must be a String
leads_attributes[caller_phone_number_attributes]
required

Phone number of the caller, if different from the tenant


Value: Must be a Hash
leads_attributes[caller_phone_number_attributes][number]
required

Phone number


Value: Must be a String
leads_attributes[caller_phone_number_attributes][extension]
optional

Phone number extension


Value: Must be a String
leads_attributes[caller_phone_number_attributes][label]
optional

A label for what the phone number is, such as Home, Work, Mobile, etc.


Value: Must be a String
leads_attributes[rate_type]
optional

The type of rate for the unit (ie. standard_rate, managed_rate, custom_rate, or channel_rate).


Value: Must be a String
leads_attributes[discount_plans]
optional

Must be an array of nested discount plan ids


Value: Must be an Array of nested elements
leads_attributes[discount_plans][id]
optional

The ID of the discount plan to apply.


Value: Must be a String