GET /v1/:facility_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/d62629d4-269b-41fd-8fc2-fadf9c38fe20/leads/reservations
200
{
  "leads": [
    {
      "id": "0feb1499-a10a-445c-9d9e-3c6ecc45b024",
      "bilingual_agent": false,
      "caller_first_name": null,
      "caller_last_name": null,
      "cancelled_at": null,
      "closed": false,
      "confirmation_number": "1000001-1-1658",
      "created_at": "2022-09-12T22:36:39.997-10:00",
      "desired_move_in_date": "2022-09-14",
      "desired_unit_size_and_price": "2x8x3 at $932.14",
      "due_at_move_in": 528.21,
      "due_monthly": 932.14,
      "extra_details": {
        "snapshot_reservation_id": "7e4f8f4a-fb8e-4cd2-ac4a-af30fb554aeb"
      },
      "facility_id": "d62629d4-269b-41fd-8fc2-fadf9c38fe20",
      "facility_time_zone": "Hawaii",
      "floor": null,
      "free_truck": false,
      "has_paid_reservation_fee": null,
      "invoiceable_fees": [],
      "kind": "walk_in",
      "lead_action_indexes": {},
      "length_of_stay_id": null,
      "move_in_from_reservation_url": null,
      "moved_in_at": null,
      "moving_labor": false,
      "moving_labor_contacted_already": false,
      "next_action_at": "2022-09-13T22:36:39.976-10:00",
      "next_lead_action": null,
      "next_lead_action_index": null,
      "origination": "lead",
      "plant_a_tree": false,
      "quoted_rate": 932.14,
      "rate_type": null,
      "reduced_price": 932.14,
      "reservation_fee_required": null,
      "reservation_window": 0,
      "reserved_at": "2022-09-12T22:36:40.034-10:00",
      "size": "2x8x3",
      "source_id": null,
      "source_name": null,
      "standard_rate": null,
      "started_at": "2022-09-12T22:36:39.997-10:00",
      "status": "reserved",
      "tenant_id": "15fc0d2c-5bc2-4e48-b619-677b50cbcb3b",
      "urgent": false,
      "wait_list": false,
      "wait_list_available": false,
      "within_reservation_window": true,
      "is_upgrade": null,
      "desired_unit_size_and_amenities": null,
      "tenant": {
        "id": "15fc0d2c-5bc2-4e48-b619-677b50cbcb3b",
        "account_number": 1000001,
        "first_name": "Ramiro51",
        "last_name": "Wehner",
        "middle_initial": null,
        "email": "elinor@kohlercarter.co51",
        "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_51",
        "drivers_license_number": null,
        "drivers_license_state": null,
        "vehicle_license_plate_number": null,
        "vehicle_license_state": null,
        "vehicle_description": null,
        "has_tenant_portal_account": false,
        "created_at": "2022-09-12T22:36:39.983-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": "e16293ae-4808-45bd-91bc-ec7040b918a6",
          "address1": "321233 Veum Square",
          "address2": null,
          "city": "South Jessie",
          "state": "CT",
          "postal": "39384",
          "country": "US",
          "full_address": "321233 Veum Square, 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": "e16293ae-4808-45bd-91bc-ec7040b918a6",
            "address1": "321233 Veum Square",
            "address2": null,
            "city": "South Jessie",
            "state": "CT",
            "postal": "39384",
            "country": "US",
            "full_address": "321233 Veum Square, 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": "d62629d4-269b-41fd-8fc2-fadf9c38fe20",
        "previous_ledger_ids": [],
        "closed_lead_ids": [],
        "contact_ids": [],
        "support_case_ids": [],
        "event_ids": [
          "3d0b3b74-c23e-4323-aed0-0334b4bbafe0"
        ],
        "password_recovery_question_ids": [
          "bbc8e8a1-7e1a-4c56-a711-75bd95ee9768",
          "1376b747-7a78-4c59-a950-827136648159"
        ]
      },
      "unit": {
        "id": "fc79250b-3123-49ca-a99e-2dcb81c478b7",
        "price": 932.14,
        "name": "U33",
        "description": "",
        "width": 2.0,
        "length": 8.0,
        "height": 3.0,
        "door_height": 9.0,
        "door_width": 3.0,
        "door_type": "roll_up",
        "access_type": "indoor",
        "floor": null,
        "directions": null,
        "size": "2x8x3",
        "area": 16.0,
        "standard_rate": 932.14,
        "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": 1956,
          "descriptor": "No Tier",
          "tiered_amenities": []
        },
        "custom_fields": [],
        "channel_rate": null,
        "unit_amenities": [],
        "unit_type": {
          "id": "c3a1b5aa-23a6-4ee9-af0c-d2dd8d93aab8",
          "name": "Unit Type 33",
          "deleted": false,
          "internal_account_code": "4000",
          "code_and_description": "4000 - Rental Revenue",
          "ii_excluded": []
        },
        "unit_group_id": "2d239503-5d92-45ca-b0c7-288087fef34e"
      },
      "length_of_stay": null,
      "successful_payment_events": [],
      "caller_phone_number": null,
      "unit_amenities": [],
      "current_user": null,
      "unit_type": {
        "id": "c3a1b5aa-23a6-4ee9-af0c-d2dd8d93aab8",
        "name": "Unit Type 33",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "close_reason": null,
      "discount_plans": [],
      "lead_contents": [],
      "unit_group": {
        "id": "2d239503-5d92-45ca-b0c7-288087fef34e",
        "price": 932.14,
        "group_key": "2x8x3 - $932.14 - 2003",
        "name": "2x8x3 - $932.14 - 2003",
        "available_units_count": 0,
        "total_units_count": 1,
        "total_non_excluded_units_count": 1,
        "size": "2x8x3",
        "standard_rate": 932.14,
        "floor": null,
        "reduced_price": 932.14,
        "cyo_reduced_prices": {},
        "occupancy_percent": 0.0,
        "area": 16.0,
        "length": 8.0,
        "width": 2.0,
        "height": 3.0,
        "due_at_move_in": 932.14,
        "due_at_move_in_without_fees": 932.14,
        "due_monthly": 932.14,
        "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": 1956,
          "descriptor": "No Tier",
          "justification": null,
          "tiered_amenities": []
        },
        "channel_rate": null,
        "unit_amenities": [],
        "unit_type": {
          "id": "c3a1b5aa-23a6-4ee9-af0c-d2dd8d93aab8",
          "name": "Unit Type 33",
          "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": "9d912ac0-0f6e-4219-9199-e6cf67ba4814",
        "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": "d62629d4-269b-41fd-8fc2-fadf9c38fe20"
    }
  }
}

Params