You can filter leads by channel category. #### Allowed values for channel
* other
* print
* sales_center
* system
* tenant_portal
* web
* web_popup
Param name | Description |
---|---|
channel_category
optional |
Validations:
|
GET /v1/53b52a3a-a95f-4538-8da9-cb6d1114a272/tenants/b5638c6d-7431-4479-9a6a-62e63c34fc88/leads/current 200 { "leads": [ { "id": "3fc0fae2-c074-4bd8-9201-7d614cb83c18", "bilingual_agent": false, "caller_first_name": null, "caller_last_name": null, "cancelled_at": null, "closed": false, "confirmation_number": "1000000-1-2741", "created_at": "2023-09-15T04:39:10.550-10:00", "desired_move_in_date": "2023-09-18", "desired_unit_size_and_price": "10x6x4 at $764.95", "due_at_move_in": 331.48, "due_monthly": 764.95, "extra_details": { "snapshot_reservation_id": "97442d2e-9f1a-4744-b163-f6782a3e5dd1" }, "facility_id": "53b52a3a-a95f-4538-8da9-cb6d1114a272", "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": 764.95, "rate_type": null, "reduced_price": 764.95, "reservation_fee_required": null, "reservation_window": 0, "reserved_at": "2023-09-15T04:39:10.834-10:00", "size": "10x6x4", "source_id": null, "source_name": null, "standard_rate": null, "started_at": "2023-09-15T04:39:10.550-10:00", "status": "reserved", "tenant_id": "b5638c6d-7431-4479-9a6a-62e63c34fc88", "urgent": false, "wait_list": false, "wait_list_available": false, "within_reservation_window": true, "is_upgrade": null, "desired_unit_size_and_amenities": null, "tenant": { "id": "b5638c6d-7431-4479-9a6a-62e63c34fc88", "account_number": 1000000, "first_name": "Malisa169", "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_169", "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:39:09.768-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": "b70421be-84ed-4654-b9ca-29d6db50b8d8", "address1": "1151132 Tyree Prairie", "address2": null, "city": "North Cruzfurt", "state": "DE", "postal": "89980", "country": "US", "full_address": "1151132 Tyree Prairie, 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": "b70421be-84ed-4654-b9ca-29d6db50b8d8", "address1": "1151132 Tyree Prairie", "address2": null, "city": "North Cruzfurt", "state": "DE", "postal": "89980", "country": "US", "full_address": "1151132 Tyree Prairie, 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": "53b52a3a-a95f-4538-8da9-cb6d1114a272", "previous_ledger_ids": [], "closed_lead_ids": [ "a465feeb-a309-4966-b386-44148ce6e8e9" ], "contact_ids": [], "support_case_ids": [], "event_ids": [ "afb88be6-0634-497b-b234-0471a7e8ffbe", "6d8e256f-b4ab-40b7-b71e-6940d252dd7c", "78d44590-cc77-4ae1-8590-298f44145013", "ccf4f5e7-5bfe-48bb-ac40-5ce000571f79" ], "password_recovery_question_ids": [ "91a5ca45-ee46-40e4-8b3a-9a543074d559", "1bebe551-0b22-45c0-9197-020183000b10" ] }, "unit": { "id": "130cd5b7-a829-4b26-886f-8b17ff1b71f5", "price": 764.95, "name": "U114", "description": "", "width": 10.0, "length": 6.0, "height": 4.0, "door_height": 10.0, "door_width": 1.0, "door_type": "roll_up", "access_type": "indoor", "floor": null, "directions": null, "size": "10x6x4", "area": 60.0, "standard_rate": 764.95, "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": "317e021a-f074-407c-84a6-6438848ac79a", "name": "Unit Type 143", "deleted": false, "internal_account_code": "4000", "code_and_description": "4000 - Rental Revenue", "ii_excluded": [] }, "tier": null, "unit_group_id": "91214df3-4b69-4324-9217-14786f370f5a" }, "length_of_stay": null, "successful_payment_events": [], "caller_phone_number": null, "unit_amenities": [], "current_user": null, "unit_type": { "id": "317e021a-f074-407c-84a6-6438848ac79a", "name": "Unit Type 143", "deleted": false, "internal_account_code": "4000", "code_and_description": "4000 - Rental Revenue", "ii_excluded": [] }, "close_reason": null, "discount_plans": [], "lead_contents": [], "unit_group": { "id": "91214df3-4b69-4324-9217-14786f370f5a", "price": 764.95, "group_key": "10x6x4 - $764.95 - 3230", "name": "U114 - Group", "available_units_count": 0, "total_units_count": 1, "total_non_excluded_units_count": 1, "size": "10x6x4", "standard_rate": 764.95, "floor": null, "reduced_price": 764.95, "cyo_reduced_prices": {}, "occupancy_percent": 0.0, "area": 60.0, "length": 6.0, "width": 10.0, "height": 4.0, "due_at_move_in": 764.95, "due_at_move_in_without_fees": 764.95, "due_monthly": 764.95, "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": "317e021a-f074-407c-84a6-6438848ac79a", "name": "Unit Type 143", "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": "785f1713-212d-4456-8b33-744a85133ee8", "name": "Test App", "type": "Source" }, "channel_id": null, "confirmation_email": null }, { "id": "b054ccd2-ba1c-4366-b48c-95eba1bed8e0", "bilingual_agent": false, "caller_first_name": null, "caller_last_name": null, "cancelled_at": null, "closed": false, "confirmation_number": null, "created_at": "2023-09-15T04:39:10.386-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": "53b52a3a-a95f-4538-8da9-cb6d1114a272", "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": "2023-09-15T04:39:10.386-10:00", "status": "created", "tenant_id": "b5638c6d-7431-4479-9a6a-62e63c34fc88", "urgent": false, "wait_list": false, "wait_list_available": false, "within_reservation_window": true, "is_upgrade": null, "desired_unit_size_and_amenities": null, "tenant": { "id": "b5638c6d-7431-4479-9a6a-62e63c34fc88", "account_number": 1000000, "first_name": "Malisa169", "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_169", "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:39:09.768-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": "b70421be-84ed-4654-b9ca-29d6db50b8d8", "address1": "1151132 Tyree Prairie", "address2": null, "city": "North Cruzfurt", "state": "DE", "postal": "89980", "country": "US", "full_address": "1151132 Tyree Prairie, 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": "b70421be-84ed-4654-b9ca-29d6db50b8d8", "address1": "1151132 Tyree Prairie", "address2": null, "city": "North Cruzfurt", "state": "DE", "postal": "89980", "country": "US", "full_address": "1151132 Tyree Prairie, 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": "53b52a3a-a95f-4538-8da9-cb6d1114a272", "previous_ledger_ids": [], "closed_lead_ids": [ "a465feeb-a309-4966-b386-44148ce6e8e9" ], "contact_ids": [], "support_case_ids": [], "event_ids": [ "afb88be6-0634-497b-b234-0471a7e8ffbe", "6d8e256f-b4ab-40b7-b71e-6940d252dd7c", "78d44590-cc77-4ae1-8590-298f44145013", "ccf4f5e7-5bfe-48bb-ac40-5ce000571f79" ], "password_recovery_question_ids": [ "91a5ca45-ee46-40e4-8b3a-9a543074d559", "1bebe551-0b22-45c0-9197-020183000b10" ] }, "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": "785f1713-212d-4456-8b33-744a85133ee8", "name": "Test App", "type": "Source" }, "channel_id": null, "confirmation_email": null }, { "id": "b85dd33d-7a1b-4554-9a51-883f72a48945", "bilingual_agent": false, "caller_first_name": null, "caller_last_name": null, "cancelled_at": null, "closed": false, "confirmation_number": null, "created_at": "2023-09-15T04:39:10.253-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": "53b52a3a-a95f-4538-8da9-cb6d1114a272", "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": "2023-09-15T04:39:10.253-10:00", "status": "created", "tenant_id": "b5638c6d-7431-4479-9a6a-62e63c34fc88", "urgent": false, "wait_list": false, "wait_list_available": false, "within_reservation_window": true, "is_upgrade": null, "desired_unit_size_and_amenities": null, "tenant": { "id": "b5638c6d-7431-4479-9a6a-62e63c34fc88", "account_number": 1000000, "first_name": "Malisa169", "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_169", "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:39:09.768-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": "b70421be-84ed-4654-b9ca-29d6db50b8d8", "address1": "1151132 Tyree Prairie", "address2": null, "city": "North Cruzfurt", "state": "DE", "postal": "89980", "country": "US", "full_address": "1151132 Tyree Prairie, 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": "b70421be-84ed-4654-b9ca-29d6db50b8d8", "address1": "1151132 Tyree Prairie", "address2": null, "city": "North Cruzfurt", "state": "DE", "postal": "89980", "country": "US", "full_address": "1151132 Tyree Prairie, 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": "53b52a3a-a95f-4538-8da9-cb6d1114a272", "previous_ledger_ids": [], "closed_lead_ids": [ "a465feeb-a309-4966-b386-44148ce6e8e9" ], "contact_ids": [], "support_case_ids": [], "event_ids": [ "afb88be6-0634-497b-b234-0471a7e8ffbe", "6d8e256f-b4ab-40b7-b71e-6940d252dd7c", "78d44590-cc77-4ae1-8590-298f44145013", "ccf4f5e7-5bfe-48bb-ac40-5ce000571f79" ], "password_recovery_question_ids": [ "91a5ca45-ee46-40e4-8b3a-9a543074d559", "1bebe551-0b22-45c0-9197-020183000b10" ] }, "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": "785f1713-212d-4456-8b33-744a85133ee8", "name": "Test App", "type": "Source" }, "channel_id": null, "confirmation_email": null }, { "id": "1e6198c4-ce9c-4990-a539-9ee1c76e6181", "bilingual_agent": false, "caller_first_name": null, "caller_last_name": null, "cancelled_at": null, "closed": false, "confirmation_number": null, "created_at": "2023-09-15T04:39:10.050-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": "53b52a3a-a95f-4538-8da9-cb6d1114a272", "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": "2023-09-15T04:39:10.050-10:00", "status": "created", "tenant_id": "b5638c6d-7431-4479-9a6a-62e63c34fc88", "urgent": false, "wait_list": false, "wait_list_available": false, "within_reservation_window": true, "is_upgrade": null, "desired_unit_size_and_amenities": null, "tenant": { "id": "b5638c6d-7431-4479-9a6a-62e63c34fc88", "account_number": 1000000, "first_name": "Malisa169", "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_169", "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:39:09.768-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": "b70421be-84ed-4654-b9ca-29d6db50b8d8", "address1": "1151132 Tyree Prairie", "address2": null, "city": "North Cruzfurt", "state": "DE", "postal": "89980", "country": "US", "full_address": "1151132 Tyree Prairie, 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": "b70421be-84ed-4654-b9ca-29d6db50b8d8", "address1": "1151132 Tyree Prairie", "address2": null, "city": "North Cruzfurt", "state": "DE", "postal": "89980", "country": "US", "full_address": "1151132 Tyree Prairie, 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": "53b52a3a-a95f-4538-8da9-cb6d1114a272", "previous_ledger_ids": [], "closed_lead_ids": [ "a465feeb-a309-4966-b386-44148ce6e8e9" ], "contact_ids": [], "support_case_ids": [], "event_ids": [ "afb88be6-0634-497b-b234-0471a7e8ffbe", "6d8e256f-b4ab-40b7-b71e-6940d252dd7c", "78d44590-cc77-4ae1-8590-298f44145013", "ccf4f5e7-5bfe-48bb-ac40-5ce000571f79" ], "password_recovery_question_ids": [ "91a5ca45-ee46-40e4-8b3a-9a543074d559", "1bebe551-0b22-45c0-9197-020183000b10" ] }, "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": "785f1713-212d-4456-8b33-744a85133ee8", "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": "53b52a3a-a95f-4538-8da9-cb6d1114a272", "tenant_id": "b5638c6d-7431-4479-9a6a-62e63c34fc88", "tenant_lead": {} } } }