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/b7e9fa70-b2b7-45af-bff7-649f77ecdbbc/leads/inquiries
200
{
  "leads": [
    {
      "id": "69829173-4bdd-4509-a117-a3a5f17b87fc",
      "bilingual_agent": false,
      "caller_first_name": null,
      "caller_last_name": null,
      "cancelled_at": null,
      "closed": false,
      "confirmation_number": null,
      "created_at": "2022-09-12T22:36:38.292-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": "b7e9fa70-b2b7-45af-bff7-649f77ecdbbc",
      "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:38.272-10:00",
      "next_lead_action": null,
      "next_lead_action_index": null,
      "origination": "lead",
      "plant_a_tree": false,
      "quoted_rate": null,
      "rate_type": null,
      "reduced_price": null,
      "reservation_fee_required": null,
      "reservation_window": 0,
      "reserved_at": null,
      "size": null,
      "source_id": null,
      "source_name": null,
      "standard_rate": null,
      "started_at": "2022-09-12T22:36:38.292-10:00",
      "status": "created",
      "tenant_id": "32be1425-3c71-437a-a5ce-b02729ab7916",
      "urgent": false,
      "wait_list": false,
      "wait_list_available": false,
      "within_reservation_window": true,
      "is_upgrade": null,
      "desired_unit_size_and_amenities": null,
      "tenant": {
        "id": "32be1425-3c71-437a-a5ce-b02729ab7916",
        "account_number": 1000000,
        "first_name": "Sharolyn41",
        "last_name": "Wehner",
        "middle_initial": null,
        "email": "tabalistreri@hirthe.biz41",
        "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_41",
        "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:38.279-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": "7294d4ea-8780-4c5e-adb6-2916c5e8175d",
          "address1": "2964015 Bednar Lodge",
          "address2": null,
          "city": "South Jessie",
          "state": "CT",
          "postal": "39384",
          "country": "US",
          "full_address": "2964015 Bednar Lodge, 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": "7294d4ea-8780-4c5e-adb6-2916c5e8175d",
            "address1": "2964015 Bednar Lodge",
            "address2": null,
            "city": "South Jessie",
            "state": "CT",
            "postal": "39384",
            "country": "US",
            "full_address": "2964015 Bednar Lodge, 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": "b7e9fa70-b2b7-45af-bff7-649f77ecdbbc",
        "previous_ledger_ids": [],
        "closed_lead_ids": [],
        "contact_ids": [],
        "support_case_ids": [],
        "event_ids": [
          "44670e82-b6eb-4d51-a08e-e84550ca8803"
        ],
        "password_recovery_question_ids": [
          "9011c552-1511-4429-8a62-2d8a90972256",
          "69bec83d-1af1-4051-a01d-a7a94e971b1f"
        ]
      },
      "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": "2f6d4b80-991e-4167-9746-f18e2f350b2d",
        "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": "b7e9fa70-b2b7-45af-bff7-649f77ecdbbc"
    }
  }
}

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