You can filter leads by channel category. The field channel
has these possible values: system
, tenant_portal
, sales_center
, web
, print
, other
, web_popup
GET /v1/40a1099f-6c75-44d3-87c0-e66ff015693d/tenants/9174ea93-002e-41a4-a8ce-2a7e2a884baf/leads/56130c64-2174-4b08-a5a1-4b283f2dc609 200 { "lead": { "id": "56130c64-2174-4b08-a5a1-4b283f2dc609", "bilingual_agent": false, "caller_first_name": null, "caller_last_name": null, "cancelled_at": null, "closed": false, "confirmation_number": "1000000-1-1792", "created_at": "2022-09-12T22:37:12.562-10:00", "desired_move_in_date": "2022-09-15", "desired_unit_size_and_price": "8x5x7 at $847.75", "due_at_move_in": 452.13, "due_monthly": 847.75, "extra_details": { "snapshot_reservation_id": "0680a43a-27eb-4a6a-981b-bf1c9b03798b", "previous_snapshot_reservation_id": "2b5cc768-8408-4a6f-90db-d2a544a09eed" }, "facility_id": "40a1099f-6c75-44d3-87c0-e66ff015693d", "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": 847.75, "rate_type": null, "reduced_price": 847.75, "reservation_fee_required": null, "reservation_window": 0, "reserved_at": "2022-09-12T22:37:12.750-10:00", "size": "8x5x7", "source_id": null, "source_name": null, "standard_rate": null, "started_at": "2022-09-12T22:37:12.562-10:00", "status": "reserved", "tenant_id": "9174ea93-002e-41a4-a8ce-2a7e2a884baf", "urgent": false, "wait_list": false, "wait_list_available": false, "within_reservation_window": true, "is_upgrade": null, "desired_unit_size_and_amenities": null, "tenant": { "id": "9174ea93-002e-41a4-a8ce-2a7e2a884baf", "account_number": 1000000, "first_name": "Maryland182", "last_name": "Wehner", "middle_initial": null, "email": "marleenlowe@goyette.name184", "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_182", "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:37:12.073-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": "95462a04-03ed-46f3-b11c-11a93988bf42", "address1": "776623 Nannie Lock", "address2": null, "city": "South Jessie", "state": "CT", "postal": "39384", "country": "US", "full_address": "776623 Nannie Lock, 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": "95462a04-03ed-46f3-b11c-11a93988bf42", "address1": "776623 Nannie Lock", "address2": null, "city": "South Jessie", "state": "CT", "postal": "39384", "country": "US", "full_address": "776623 Nannie Lock, 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": "40a1099f-6c75-44d3-87c0-e66ff015693d", "previous_ledger_ids": [], "closed_lead_ids": [ "6c405cca-5988-4482-8849-c4b85611b09c" ], "contact_ids": [], "support_case_ids": [], "event_ids": [ "c2fd8a9e-f15f-435e-98d6-c42141679f9a", "36f0ef11-526d-4d28-85b6-8008e35ade47", "d00dc268-6c93-4141-ab4d-03b42ab999de", "0a6215b4-d18b-4384-baec-11c4f57c691a" ], "password_recovery_question_ids": [ "6345498e-7bcb-44e5-a177-185a2bc7d4ac", "b87632ff-f60c-49f2-aaee-0a97fdc86789" ] }, "unit": { "id": "a468355c-d9e1-4f85-ae97-d6bcc3585f0f", "price": 847.75, "name": "U118", "description": "", "width": 8.0, "length": 5.0, "height": 7.0, "door_height": 10.0, "door_width": 2.0, "door_type": "roll_up", "access_type": "indoor", "floor": null, "directions": null, "size": "8x5x7", "area": 40.0, "standard_rate": 847.75, "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": 2041, "descriptor": "No Tier", "tiered_amenities": [] }, "custom_fields": [], "channel_rate": null, "unit_amenities": [], "unit_type": { "id": "2e7dc820-4849-4c5c-b2ff-b8e36f6f6200", "name": "Unit Type 134", "deleted": false, "internal_account_code": "4000", "code_and_description": "4000 - Rental Revenue", "ii_excluded": [] }, "unit_group_id": "cb5e5cfb-2235-49b1-8c1b-3047f48129ab" }, "length_of_stay": null, "successful_payment_events": [], "caller_phone_number": null, "unit_amenities": [], "current_user": null, "unit_type": { "id": "2e7dc820-4849-4c5c-b2ff-b8e36f6f6200", "name": "Unit Type 134", "deleted": false, "internal_account_code": "4000", "code_and_description": "4000 - Rental Revenue", "ii_excluded": [] }, "close_reason": null, "discount_plans": [], "lead_contents": [], "unit_group": { "id": "cb5e5cfb-2235-49b1-8c1b-3047f48129ab", "price": 847.75, "group_key": "8x5x7 - $847.75 - 2105", "name": "8x5x7 - $847.75 - 2105", "available_units_count": 0, "total_units_count": 1, "total_non_excluded_units_count": 1, "size": "8x5x7", "standard_rate": 847.75, "floor": null, "reduced_price": 847.75, "cyo_reduced_prices": {}, "occupancy_percent": 0.0, "area": 40.0, "length": 5.0, "width": 8.0, "height": 7.0, "due_at_move_in": 847.75, "due_at_move_in_without_fees": 847.75, "due_monthly": 847.75, "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": 2041, "descriptor": "No Tier", "justification": null, "tiered_amenities": [] }, "channel_rate": null, "unit_amenities": [], "unit_type": { "id": "2e7dc820-4849-4c5c-b2ff-b8e36f6f6200", "name": "Unit Type 134", "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": "ed7dd150-64c9-4659-b6d8-bfc89d44848f", "name": "Test App", "type": "Source" }, "channel_id": null, "confirmation_email": null }, "meta": { "status_code": 200, "status_message": "OK", "status_cat": "https://http.cat/200", "request_method": "GET", "request_id": null, "parameters": { "facility_id": "40a1099f-6c75-44d3-87c0-e66ff015693d", "tenant_id": "9174ea93-002e-41a4-a8ce-2a7e2a884baf", "id": "56130c64-2174-4b08-a5a1-4b283f2dc609" } } }
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>. |
id required |
Value: Must be a String |