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/12cf1ce0-5c9e-4482-a00f-998b14eb716c/leads/follow_up
200
{
  "leads": [
    {
      "id": "921fca55-4ad2-441d-b0df-c12687ed1876",
      "bilingual_agent": false,
      "caller_first_name": null,
      "caller_last_name": null,
      "cancelled_at": null,
      "closed": false,
      "confirmation_number": "1000001-1-1652",
      "created_at": "2022-09-12T22:36:38.862-10:00",
      "desired_move_in_date": "2022-09-14",
      "desired_unit_size_and_price": "7x2x1 at $927.66",
      "due_at_move_in": 525.67,
      "due_monthly": 927.66,
      "extra_details": {
        "snapshot_reservation_id": "749cb95a-df52-4918-97bf-ba306211b018"
      },
      "facility_id": "12cf1ce0-5c9e-4482-a00f-998b14eb716c",
      "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.842-10:00",
      "next_lead_action": null,
      "next_lead_action_index": null,
      "origination": "lead",
      "plant_a_tree": false,
      "quoted_rate": 927.66,
      "rate_type": null,
      "reduced_price": 927.66,
      "reservation_fee_required": null,
      "reservation_window": 0,
      "reserved_at": "2022-09-12T22:36:38.903-10:00",
      "size": "7x2x1",
      "source_id": null,
      "source_name": null,
      "standard_rate": null,
      "started_at": "2022-09-12T22:36:38.862-10:00",
      "status": "reserved",
      "tenant_id": "a574ea1a-d2c4-49c0-bd0f-b48e8fafae44",
      "urgent": false,
      "wait_list": false,
      "wait_list_available": false,
      "within_reservation_window": true,
      "is_upgrade": null,
      "desired_unit_size_and_amenities": null,
      "tenant": {
        "id": "a574ea1a-d2c4-49c0-bd0f-b48e8fafae44",
        "account_number": 1000001,
        "first_name": "Scot45",
        "last_name": "Wehner",
        "middle_initial": null,
        "email": "clarinepouros@mertztoy.com45",
        "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_45",
        "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.848-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": "863e1a62-23e5-4437-91f1-1dd664fb3f6a",
          "address1": "305552 Berge Divide",
          "address2": null,
          "city": "South Jessie",
          "state": "CT",
          "postal": "39384",
          "country": "US",
          "full_address": "305552 Berge Divide, 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": "863e1a62-23e5-4437-91f1-1dd664fb3f6a",
            "address1": "305552 Berge Divide",
            "address2": null,
            "city": "South Jessie",
            "state": "CT",
            "postal": "39384",
            "country": "US",
            "full_address": "305552 Berge Divide, 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": "12cf1ce0-5c9e-4482-a00f-998b14eb716c",
        "previous_ledger_ids": [],
        "closed_lead_ids": [],
        "contact_ids": [],
        "support_case_ids": [],
        "event_ids": [
          "5a290595-3e17-4478-b1aa-50d25dc8b3ab"
        ],
        "password_recovery_question_ids": [
          "faf9ac9a-749d-4de9-a635-a9b398e39236",
          "9049e796-8e50-4e5a-a86d-da6a6a05c1fd"
        ]
      },
      "unit": {
        "id": "c22004e3-5cfb-4de0-8389-26960becc226",
        "price": 927.66,
        "name": "U31",
        "description": "",
        "width": 7.0,
        "length": 2.0,
        "height": 1.0,
        "door_height": 8.0,
        "door_width": 4.0,
        "door_type": "roll_up",
        "access_type": "indoor",
        "floor": null,
        "directions": null,
        "size": "7x2x1",
        "area": 14.0,
        "standard_rate": 927.66,
        "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": 1954,
          "descriptor": "No Tier",
          "tiered_amenities": []
        },
        "custom_fields": [],
        "channel_rate": null,
        "unit_amenities": [],
        "unit_type": {
          "id": "b9371e24-47e4-46e3-84c8-bdf5020b0960",
          "name": "Unit Type 31",
          "deleted": false,
          "internal_account_code": "4000",
          "code_and_description": "4000 - Rental Revenue",
          "ii_excluded": []
        },
        "unit_group_id": "b3654cbe-a02a-4396-a3f7-3bc43702453e"
      },
      "length_of_stay": null,
      "successful_payment_events": [],
      "caller_phone_number": null,
      "unit_amenities": [],
      "current_user": null,
      "unit_type": {
        "id": "b9371e24-47e4-46e3-84c8-bdf5020b0960",
        "name": "Unit Type 31",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "close_reason": null,
      "discount_plans": [],
      "lead_contents": [],
      "unit_group": {
        "id": "b3654cbe-a02a-4396-a3f7-3bc43702453e",
        "price": 927.66,
        "group_key": "7x2x1 - $927.66 - 2001",
        "name": "7x2x1 - $927.66 - 2001",
        "available_units_count": 0,
        "total_units_count": 1,
        "total_non_excluded_units_count": 1,
        "size": "7x2x1",
        "standard_rate": 927.66,
        "floor": null,
        "reduced_price": 927.66,
        "cyo_reduced_prices": {},
        "occupancy_percent": 0.0,
        "area": 14.0,
        "length": 2.0,
        "width": 7.0,
        "height": 1.0,
        "due_at_move_in": 927.66,
        "due_at_move_in_without_fees": 927.66,
        "due_monthly": 927.66,
        "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": 1954,
          "descriptor": "No Tier",
          "justification": null,
          "tiered_amenities": []
        },
        "channel_rate": null,
        "unit_amenities": [],
        "unit_type": {
          "id": "b9371e24-47e4-46e3-84c8-bdf5020b0960",
          "name": "Unit Type 31",
          "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": "fdf3e8c8-c7de-4216-a1e5-e75170e953aa",
        "name": "Test App",
        "type": "Source"
      },
      "channel_id": null,
      "confirmation_email": null
    },
    {
      "id": "aa23ce02-16f8-47a9-b692-633c42da1711",
      "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.822-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": "12cf1ce0-5c9e-4482-a00f-998b14eb716c",
      "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.799-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.822-10:00",
      "status": "created",
      "tenant_id": "f00ec1f6-7800-4e1c-a079-99b1b9c85fc5",
      "urgent": false,
      "wait_list": false,
      "wait_list_available": false,
      "within_reservation_window": true,
      "is_upgrade": null,
      "desired_unit_size_and_amenities": null,
      "tenant": {
        "id": "f00ec1f6-7800-4e1c-a079-99b1b9c85fc5",
        "account_number": 1000000,
        "first_name": "Donnie44",
        "last_name": "Wehner",
        "middle_initial": null,
        "email": "chadwickkuphal@jacobsonrippin.name44",
        "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_44",
        "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.806-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": "80f77e88-ad34-46a3-897d-666db8b31829",
          "address1": "304119 Feeney Orchard",
          "address2": null,
          "city": "South Jessie",
          "state": "CT",
          "postal": "39384",
          "country": "US",
          "full_address": "304119 Feeney Orchard, 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": "80f77e88-ad34-46a3-897d-666db8b31829",
            "address1": "304119 Feeney Orchard",
            "address2": null,
            "city": "South Jessie",
            "state": "CT",
            "postal": "39384",
            "country": "US",
            "full_address": "304119 Feeney Orchard, 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": "12cf1ce0-5c9e-4482-a00f-998b14eb716c",
        "previous_ledger_ids": [],
        "closed_lead_ids": [],
        "contact_ids": [],
        "support_case_ids": [],
        "event_ids": [
          "010c4d42-9878-4bb7-b4aa-772a0fef4f31"
        ],
        "password_recovery_question_ids": [
          "d7c820c1-8083-4e00-82b3-f350cc9f371c",
          "6042d472-5a1b-4bd3-8ef9-314a9ec55339"
        ]
      },
      "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": "fdf3e8c8-c7de-4216-a1e5-e75170e953aa",
        "name": "Test App",
        "type": "Source"
      },
      "channel_id": null,
      "confirmation_email": null
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "total_pages": 1,
      "per_page": 100,
      "total_entries": 2,
      "previous_page": null,
      "next_page": null
    },
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "GET",
    "request_id": null,
    "parameters": {
      "facility_id": "12cf1ce0-5c9e-4482-a00f-998b14eb716c"
    }
  }
}

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