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/14f928d2-02b0-4410-bdf1-7104b5c28b73/leads/current 200 { "leads": [ { "id": "518d9d71-52dc-448a-8e1c-83d3371af38e", "bilingual_agent": false, "caller_first_name": null, "caller_last_name": null, "cancelled_at": null, "closed": false, "confirmation_number": "1000001-1-2688", "created_at": "2023-09-15T04:38:02.425-10:00", "desired_move_in_date": "2023-09-17", "desired_unit_size_and_price": "5x9x3 at $848.50", "due_at_move_in": 395.97, "due_monthly": 848.5, "extra_details": { "snapshot_reservation_id": "99e4cfc6-2ddf-49e8-b74d-ff83737af7a7" }, "facility_id": "14f928d2-02b0-4410-bdf1-7104b5c28b73", "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:02.394-10:00", "next_lead_action": null, "next_lead_action_index": null, "origination": "lead", "plant_a_tree": false, "quoted_rate": 848.5, "rate_type": null, "reduced_price": 848.5, "reservation_fee_required": null, "reservation_window": 0, "reserved_at": "2023-09-15T04:38:02.491-10:00", "size": "5x9x3", "source_id": null, "source_name": null, "standard_rate": null, "started_at": "2023-09-15T04:38:02.425-10:00", "status": "reserved", "tenant_id": "7c08741d-ebc7-439c-820c-9bc08320acd4", "urgent": false, "wait_list": false, "wait_list_available": false, "within_reservation_window": true, "is_upgrade": null, "desired_unit_size_and_amenities": null, "tenant": { "id": "7c08741d-ebc7-439c-820c-9bc08320acd4", "account_number": 1000001, "first_name": "Bong116", "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_116", "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:02.407-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": "5f31b330-5d79-4f2b-8a28-df27ad8a14b7", "address1": "733846 O'Reilly Stravenue", "address2": null, "city": "North Cruzfurt", "state": "DE", "postal": "89980", "country": "US", "full_address": "733846 O'Reilly Stravenue, 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": "5f31b330-5d79-4f2b-8a28-df27ad8a14b7", "address1": "733846 O'Reilly Stravenue", "address2": null, "city": "North Cruzfurt", "state": "DE", "postal": "89980", "country": "US", "full_address": "733846 O'Reilly Stravenue, 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": "14f928d2-02b0-4410-bdf1-7104b5c28b73", "previous_ledger_ids": [], "closed_lead_ids": [], "contact_ids": [], "support_case_ids": [], "event_ids": [ "2c3c5092-6819-4a60-bab6-63920704f81c" ], "password_recovery_question_ids": [ "77796d2c-52d7-4c9a-93cf-82fdc883cd30", "300c6e61-87ec-479a-a4a5-aa25794360d9" ] }, "unit": { "id": "4995c9c7-f401-4f77-8b77-78fca1925ebe", "price": 848.5, "name": "U81", "description": "", "width": 5.0, "length": 9.0, "height": 3.0, "door_height": 8.0, "door_width": 4.0, "door_type": "roll_up", "access_type": "indoor", "floor": null, "directions": null, "size": "5x9x3", "area": 45.0, "standard_rate": 848.5, "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": "834b613a-33e7-4f72-b3c6-28a72dc771ff", "name": "Unit Type 104", "deleted": false, "internal_account_code": "4000", "code_and_description": "4000 - Rental Revenue", "ii_excluded": [] }, "tier": null, "unit_group_id": "12aaae4e-0a21-4279-b623-da4f8ae66278" }, "length_of_stay": null, "successful_payment_events": [], "caller_phone_number": null, "unit_amenities": [], "current_user": null, "unit_type": { "id": "834b613a-33e7-4f72-b3c6-28a72dc771ff", "name": "Unit Type 104", "deleted": false, "internal_account_code": "4000", "code_and_description": "4000 - Rental Revenue", "ii_excluded": [] }, "close_reason": null, "discount_plans": [], "lead_contents": [], "unit_group": { "id": "12aaae4e-0a21-4279-b623-da4f8ae66278", "price": 848.5, "group_key": "5x9x3 - $848.50 - 3191", "name": "U81 - Group", "available_units_count": 0, "total_units_count": 1, "total_non_excluded_units_count": 1, "size": "5x9x3", "standard_rate": 848.5, "floor": null, "reduced_price": 848.5, "cyo_reduced_prices": {}, "occupancy_percent": 0.0, "area": 45.0, "length": 9.0, "width": 5.0, "height": 3.0, "due_at_move_in": 848.5, "due_at_move_in_without_fees": 848.5, "due_monthly": 848.5, "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": "834b613a-33e7-4f72-b3c6-28a72dc771ff", "name": "Unit Type 104", "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": "9d06ae60-f7df-4fe5-be56-466b856f8f47", "name": "Test App", "type": "Source" }, "channel_id": null, "confirmation_email": null }, { "id": "36b1c260-d262-40a6-8049-189cd320c270", "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:02.361-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": "14f928d2-02b0-4410-bdf1-7104b5c28b73", "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:02.329-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:02.361-10:00", "status": "created", "tenant_id": "14747d37-7c8a-42a4-8170-33306afba802", "urgent": false, "wait_list": false, "wait_list_available": false, "within_reservation_window": true, "is_upgrade": null, "desired_unit_size_and_amenities": null, "tenant": { "id": "14747d37-7c8a-42a4-8170-33306afba802", "account_number": 1000000, "first_name": "Stevie115", "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_115", "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:02.341-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": "2b966b17-a43a-427a-b0d8-876c0d1450ba", "address1": "7321138 Hegmann Walks", "address2": null, "city": "North Cruzfurt", "state": "DE", "postal": "89980", "country": "US", "full_address": "7321138 Hegmann Walks, 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": "2b966b17-a43a-427a-b0d8-876c0d1450ba", "address1": "7321138 Hegmann Walks", "address2": null, "city": "North Cruzfurt", "state": "DE", "postal": "89980", "country": "US", "full_address": "7321138 Hegmann Walks, 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": "14f928d2-02b0-4410-bdf1-7104b5c28b73", "previous_ledger_ids": [], "closed_lead_ids": [], "contact_ids": [], "support_case_ids": [], "event_ids": [ "a271d900-8c89-41b1-b6dc-643475b37d8c" ], "password_recovery_question_ids": [ "0cc5f179-c3a2-4788-a324-aff123ad9398", "e9075101-e01a-4484-89a0-38c9aa7efc69" ] }, "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": "9d06ae60-f7df-4fe5-be56-466b856f8f47", "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": "14f928d2-02b0-4410-bdf1-7104b5c28b73", "lead": {} } } }