You can filter leads by channel category. #### Allowed values for channel
* other
* print
* sales_center
* system
* tenant_portal
* web
* web_popup

Params

Param name Description
channel_category
optional

Validations:

  • Must be one of: system, tenantportal, salescenter, web, print, other, web_popup.

Examples

GET /v1/7997dc10-9896-4123-b450-e5fb751fee08/leads/follow_up
200
{
  "leads": [
    {
      "id": "ffe70566-53d6-474b-833e-3aba3b32683a",
      "bilingual_agent": false,
      "caller_first_name": null,
      "caller_last_name": null,
      "cancelled_at": null,
      "closed": false,
      "confirmation_number": "1000001-1-2703",
      "created_at": "2023-09-15T04:38:07.766-10:00",
      "desired_move_in_date": "2023-09-17",
      "desired_unit_size_and_price": "4x4x4 at $30.38",
      "due_at_move_in": 14.18,
      "due_monthly": 30.38,
      "extra_details": {
        "snapshot_reservation_id": "a8585629-1b55-4068-8769-f96b8380a9a4"
      },
      "facility_id": "7997dc10-9896-4123-b450-e5fb751fee08",
      "facility_time_zone": "Hawaii",
      "floor": null,
      "free_truck": false,
      "has_paid_reservation_fee": null,
      "invoiceable_fees": [],
      "kind": "walk_in",
      "lead_action_indexes": {},
      "length_of_stay_id": null,
      "move_in_from_reservation_url": null,
      "moved_in_at": null,
      "moving_labor": false,
      "moving_labor_contacted_already": false,
      "next_action_at": "2023-09-16T04:38:07.739-10:00",
      "next_lead_action": null,
      "next_lead_action_index": null,
      "origination": "lead",
      "plant_a_tree": false,
      "quoted_rate": 30.38,
      "rate_type": null,
      "reduced_price": 30.38,
      "reservation_fee_required": null,
      "reservation_window": 0,
      "reserved_at": "2023-09-15T04:38:07.824-10:00",
      "size": "4x4x4",
      "source_id": null,
      "source_name": null,
      "standard_rate": null,
      "started_at": "2023-09-15T04:38:07.767-10:00",
      "status": "reserved",
      "tenant_id": "fc6982c3-abe9-49cc-b3f0-bb2d5abf1b2e",
      "urgent": false,
      "wait_list": false,
      "wait_list_available": false,
      "within_reservation_window": true,
      "is_upgrade": null,
      "desired_unit_size_and_amenities": null,
      "tenant": {
        "id": "fc6982c3-abe9-49cc-b3f0-bb2d5abf1b2e",
        "account_number": 1000001,
        "first_name": "Sean131",
        "last_name": "Quigley",
        "middle_initial": null,
        "email": "[email protected]",
        "tax_exempt": false,
        "is_military": false,
        "is_business": false,
        "business_name": null,
        "last_sign_in_at": null,
        "title": null,
        "delinquent": false,
        "current_ledger_ids": [],
        "preferences": {
          "email_invoices": true,
          "print_invoices": false,
          "charge_invoice_fee": true,
          "receive_legal_notices_by_email": null,
          "delinquency_exempt": false,
          "delinquency_docs_by_email": false,
          "delinquency_docs_by_mail": false,
          "receive_sms_for_gate_activity": false,
          "opt_in_to_marketing_emails": false,
          "opt_in_to_marketing_sms": false,
          "opt_in_to_transactional_sms": false,
          "exclude_from_insurance_auto_enroll": false,
          "exclude_from_insurance_auto_enroll_reason": null,
          "exclude_from_insurance_auto_enroll_created_by": null,
          "exclude_from_insurance_auto_enroll_on": null
        },
        "military_information": null,
        "username": "username_131",
        "drivers_license_number": null,
        "drivers_license_state": null,
        "vehicle_license_plate_number": null,
        "vehicle_license_state": null,
        "vehicle_description": null,
        "has_tenant_portal_account": false,
        "created_at": "2023-09-15T04:38:07.748-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": "c797512e-3470-44a6-8875-037b00137c66",
          "address1": "7739337 Federico Spurs",
          "address2": null,
          "city": "North Cruzfurt",
          "state": "DE",
          "postal": "89980",
          "country": "US",
          "full_address": "7739337 Federico Spurs, North Cruzfurt, DE 89980",
          "latitude": 39.114844,
          "longitude": -94.630169,
          "time_zone_id": "America/New_York",
          "time_zone_offset": "-04:00",
          "invalid_data": false,
          "label": "Home"
        },
        "addresses": [
          {
            "id": "c797512e-3470-44a6-8875-037b00137c66",
            "address1": "7739337 Federico Spurs",
            "address2": null,
            "city": "North Cruzfurt",
            "state": "DE",
            "postal": "89980",
            "country": "US",
            "full_address": "7739337 Federico Spurs, North Cruzfurt, DE 89980",
            "latitude": 39.114844,
            "longitude": -94.630169,
            "time_zone_id": "America/New_York",
            "time_zone_offset": "-04:00",
            "invalid_data": false,
            "label": "Home"
          }
        ],
        "facility_id": "7997dc10-9896-4123-b450-e5fb751fee08",
        "previous_ledger_ids": [],
        "closed_lead_ids": [],
        "contact_ids": [],
        "support_case_ids": [],
        "event_ids": [
          "453e1653-298d-4f85-a280-63262a7af9aa"
        ],
        "password_recovery_question_ids": [
          "6a401822-1e60-471c-ac24-fe0f314e514f",
          "38d42fbe-f355-4d14-a168-a0b1d2af9914"
        ]
      },
      "unit": {
        "id": "c4a867b9-ed7a-4c37-b3be-2d00c874bd6d",
        "price": 30.38,
        "name": "U86",
        "description": "",
        "width": 4.0,
        "length": 4.0,
        "height": 4.0,
        "door_height": 1.0,
        "door_width": 3.0,
        "door_type": "roll_up",
        "access_type": "indoor",
        "floor": null,
        "directions": null,
        "size": "4x4x4",
        "area": 16.0,
        "standard_rate": 30.38,
        "managed_rate": null,
        "tiered_rate": null,
        "available_for_move_in": false,
        "rentable": true,
        "status": "reserved",
        "payment_status": null,
        "current_ledger_id": null,
        "current_tenant_id": null,
        "combo_lock_group": null,
        "combination_lock_number": null,
        "overlock_lock_number": null,
        "attribute_description": null,
        "deleted": false,
        "damaged": false,
        "complimentary": null,
        "unrentable": false,
        "company_owned": false,
        "is_prepped": null,
        "rank": null,
        "custom_fields": [],
        "allow_future_move_ins_limit": null,
        "channel_rate": null,
        "unit_amenities": [],
        "unit_type": {
          "id": "40101a17-fb4c-425a-b62d-067c0eddf8a2",
          "name": "Unit Type 109",
          "deleted": false,
          "internal_account_code": "4000",
          "code_and_description": "4000 - Rental Revenue",
          "ii_excluded": []
        },
        "tier": null,
        "unit_group_id": "0a21493e-4d42-43cd-8973-60e3f1f6a5b5"
      },
      "length_of_stay": null,
      "successful_payment_events": [],
      "caller_phone_number": null,
      "unit_amenities": [],
      "current_user": null,
      "unit_type": {
        "id": "40101a17-fb4c-425a-b62d-067c0eddf8a2",
        "name": "Unit Type 109",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "close_reason": null,
      "discount_plans": [],
      "lead_contents": [],
      "unit_group": {
        "id": "0a21493e-4d42-43cd-8973-60e3f1f6a5b5",
        "price": 30.38,
        "group_key": "4x4x4 - $30.38 - 3196",
        "name": "U86 - Group",
        "available_units_count": 0,
        "total_units_count": 1,
        "total_non_excluded_units_count": 1,
        "size": "4x4x4",
        "standard_rate": 30.38,
        "floor": null,
        "reduced_price": 30.38,
        "cyo_reduced_prices": {},
        "occupancy_percent": 0.0,
        "area": 16.0,
        "length": 4.0,
        "width": 4.0,
        "height": 4.0,
        "due_at_move_in": 30.38,
        "due_at_move_in_without_fees": 30.38,
        "due_monthly": 30.38,
        "attribute_description": null,
        "description": "",
        "invoiceable_fees": [],
        "average_rent": 0.0,
        "active_rate_type": "standard_rate",
        "scheduled_move_outs": [],
        "managed_rate": null,
        "reservation_fee": null,
        "reference_unit_id": null,
        "channel_rate": null,
        "unit_amenities": [],
        "unit_type": {
          "id": "40101a17-fb4c-425a-b62d-067c0eddf8a2",
          "name": "Unit Type 109",
          "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": "cbf19bc9-3a26-447b-9c8e-7ff352fde6b1",
        "name": "Test App",
        "type": "Source"
      },
      "channel_id": null,
      "confirmation_email": null
    },
    {
      "id": "82f65ed6-96eb-4795-90b7-fb6d08375951",
      "bilingual_agent": false,
      "caller_first_name": null,
      "caller_last_name": null,
      "cancelled_at": null,
      "closed": false,
      "confirmation_number": null,
      "created_at": "2023-09-15T04:38:07.714-10:00",
      "desired_move_in_date": "2023-09-15",
      "desired_unit_size_and_price": null,
      "due_at_move_in": null,
      "due_monthly": null,
      "extra_details": {},
      "facility_id": "7997dc10-9896-4123-b450-e5fb751fee08",
      "facility_time_zone": "Hawaii",
      "floor": null,
      "free_truck": false,
      "has_paid_reservation_fee": null,
      "invoiceable_fees": [],
      "kind": "walk_in",
      "lead_action_indexes": {},
      "length_of_stay_id": null,
      "move_in_from_reservation_url": null,
      "moved_in_at": null,
      "moving_labor": false,
      "moving_labor_contacted_already": false,
      "next_action_at": "2023-09-16T04:38:07.684-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": "2023-09-15T04:38:07.714-10:00",
      "status": "created",
      "tenant_id": "32db6e3a-2558-40dd-8b22-38a35c20b9a8",
      "urgent": false,
      "wait_list": false,
      "wait_list_available": false,
      "within_reservation_window": true,
      "is_upgrade": null,
      "desired_unit_size_and_amenities": null,
      "tenant": {
        "id": "32db6e3a-2558-40dd-8b22-38a35c20b9a8",
        "account_number": 1000000,
        "first_name": "Chanda130",
        "last_name": "Quigley",
        "middle_initial": null,
        "email": "[email protected]",
        "tax_exempt": false,
        "is_military": false,
        "is_business": false,
        "business_name": null,
        "last_sign_in_at": null,
        "title": null,
        "delinquent": false,
        "current_ledger_ids": [],
        "preferences": {
          "email_invoices": true,
          "print_invoices": false,
          "charge_invoice_fee": true,
          "receive_legal_notices_by_email": null,
          "delinquency_exempt": false,
          "delinquency_docs_by_email": false,
          "delinquency_docs_by_mail": false,
          "receive_sms_for_gate_activity": false,
          "opt_in_to_marketing_emails": false,
          "opt_in_to_marketing_sms": false,
          "opt_in_to_transactional_sms": false,
          "exclude_from_insurance_auto_enroll": false,
          "exclude_from_insurance_auto_enroll_reason": null,
          "exclude_from_insurance_auto_enroll_created_by": null,
          "exclude_from_insurance_auto_enroll_on": null
        },
        "military_information": null,
        "username": "username_130",
        "drivers_license_number": null,
        "drivers_license_state": null,
        "vehicle_license_plate_number": null,
        "vehicle_license_state": null,
        "vehicle_description": null,
        "has_tenant_portal_account": false,
        "created_at": "2023-09-15T04:38:07.694-10:00",
        "gate_24_hour_access": false,
        "active": true,
        "tenant_account_kind_name": "Standard",
        "blocked_payments": false,
        "date_of_birth": null,
        "phone_numbers": [],
        "mailing_address": {
          "id": "aaee2eca-ba3e-455a-948e-7b7828dad74c",
          "address1": "7723668 Rashad Junction",
          "address2": null,
          "city": "North Cruzfurt",
          "state": "DE",
          "postal": "89980",
          "country": "US",
          "full_address": "7723668 Rashad Junction, North Cruzfurt, DE 89980",
          "latitude": 39.114844,
          "longitude": -94.630169,
          "time_zone_id": "America/New_York",
          "time_zone_offset": "-04:00",
          "invalid_data": false,
          "label": "Home"
        },
        "addresses": [
          {
            "id": "aaee2eca-ba3e-455a-948e-7b7828dad74c",
            "address1": "7723668 Rashad Junction",
            "address2": null,
            "city": "North Cruzfurt",
            "state": "DE",
            "postal": "89980",
            "country": "US",
            "full_address": "7723668 Rashad Junction, North Cruzfurt, DE 89980",
            "latitude": 39.114844,
            "longitude": -94.630169,
            "time_zone_id": "America/New_York",
            "time_zone_offset": "-04:00",
            "invalid_data": false,
            "label": "Home"
          }
        ],
        "facility_id": "7997dc10-9896-4123-b450-e5fb751fee08",
        "previous_ledger_ids": [],
        "closed_lead_ids": [],
        "contact_ids": [],
        "support_case_ids": [],
        "event_ids": [
          "c66b7a1a-77ab-431d-8a3b-776b2c34317c"
        ],
        "password_recovery_question_ids": [
          "8be7381e-8947-40f1-9183-537ff3be8007",
          "19beb50d-c5fb-496e-9b73-45d710088094"
        ]
      },
      "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": "cbf19bc9-3a26-447b-9c8e-7ff352fde6b1",
        "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": "7997dc10-9896-4123-b450-e5fb751fee08",
      "lead": {}
    }
  }
}