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.

id
required

Validations:

  • Must be a String

Examples

GET /v1/305ff03a-aead-4712-a336-fa4fa0c187d8/leads/f6d8ffc1-09c7-4c95-8bc8-68fe2bbfe6a4
200
{
  "lead": {
    "id": "f6d8ffc1-09c7-4c95-8bc8-68fe2bbfe6a4",
    "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:01.449-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": "305ff03a-aead-4712-a336-fa4fa0c187d8",
    "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:01.423-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:01.449-10:00",
    "status": "created",
    "tenant_id": "cf9b14a7-fced-4850-8b1f-798ce0bb21eb",
    "urgent": false,
    "wait_list": false,
    "wait_list_available": false,
    "within_reservation_window": true,
    "is_upgrade": null,
    "desired_unit_size_and_amenities": null,
    "tenant": {
      "id": "cf9b14a7-fced-4850-8b1f-798ce0bb21eb",
      "account_number": 1000000,
      "first_name": "Cary112",
      "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_112",
      "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:01.433-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": "f34fec33-028d-444d-b31f-cd389f4e47ab",
        "address1": "724989 Beier Meadows",
        "address2": null,
        "city": "North Cruzfurt",
        "state": "DE",
        "postal": "89980",
        "country": "US",
        "full_address": "724989 Beier Meadows, 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": "f34fec33-028d-444d-b31f-cd389f4e47ab",
          "address1": "724989 Beier Meadows",
          "address2": null,
          "city": "North Cruzfurt",
          "state": "DE",
          "postal": "89980",
          "country": "US",
          "full_address": "724989 Beier Meadows, 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": "305ff03a-aead-4712-a336-fa4fa0c187d8",
      "previous_ledger_ids": [],
      "closed_lead_ids": [],
      "contact_ids": [],
      "support_case_ids": [],
      "event_ids": [
        "9e0b1e7f-9428-46e6-b3cb-916d47fcc829"
      ],
      "password_recovery_question_ids": [
        "f2c1bb50-38cb-4e95-a226-64882829c346",
        "cdf9d137-8071-4104-8747-945353f263a4"
      ]
    },
    "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": "0681a433-d3b7-4f26-ae59-0b34171751ee",
      "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": "305ff03a-aead-4712-a336-fa4fa0c187d8",
      "id": "f6d8ffc1-09c7-4c95-8bc8-68fe2bbfe6a4",
      "lead": {}
    }
  }
}