You can filter leads by channel category. The field channel has these possible values: system, tenant_portal, sales_center, web, print, other, web_popup

Examples

GET /v1/9fa6c459-56ae-47fc-aece-e739f2102c22/leads/ad0332ce-e4d8-4cd1-89c3-57d5278d59c1
200
{
  "lead": {
    "id": "ad0332ce-e4d8-4cd1-89c3-57d5278d59c1",
    "bilingual_agent": false,
    "caller_first_name": null,
    "caller_last_name": null,
    "cancelled_at": null,
    "closed": false,
    "confirmation_number": null,
    "created_at": "2022-09-12T22:36:40.474-10:00",
    "desired_move_in_date": "2022-09-12",
    "desired_unit_size_and_price": null,
    "due_at_move_in": null,
    "due_monthly": null,
    "extra_details": {},
    "facility_id": "9fa6c459-56ae-47fc-aece-e739f2102c22",
    "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": "2022-09-13T22:36:40.450-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": "2022-09-12T22:36:40.474-10:00",
    "status": "created",
    "tenant_id": "51091a18-91aa-4974-9e5d-60361c2eb252",
    "urgent": false,
    "wait_list": false,
    "wait_list_available": false,
    "within_reservation_window": true,
    "is_upgrade": null,
    "desired_unit_size_and_amenities": null,
    "tenant": {
      "id": "51091a18-91aa-4974-9e5d-60361c2eb252",
      "account_number": 1000000,
      "first_name": "Antonia53",
      "last_name": "Wehner",
      "middle_initial": null,
      "email": "doylekutch@skiles.info53",
      "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_53",
      "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:36:40.457-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": "2a3eb6ab-cf0f-4685-aed8-6d2bf06a7564",
        "address1": "328214 Schuppe Inlet",
        "address2": null,
        "city": "South Jessie",
        "state": "CT",
        "postal": "39384",
        "country": "US",
        "full_address": "328214 Schuppe Inlet, 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": "2a3eb6ab-cf0f-4685-aed8-6d2bf06a7564",
          "address1": "328214 Schuppe Inlet",
          "address2": null,
          "city": "South Jessie",
          "state": "CT",
          "postal": "39384",
          "country": "US",
          "full_address": "328214 Schuppe Inlet, 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": "9fa6c459-56ae-47fc-aece-e739f2102c22",
      "previous_ledger_ids": [],
      "closed_lead_ids": [],
      "contact_ids": [],
      "support_case_ids": [],
      "event_ids": [
        "3ee12abc-1080-4141-9bb1-a204ef65c9f5"
      ],
      "password_recovery_question_ids": [
        "4bfa864a-de9d-4c64-bfbc-37fa7ffa4b49",
        "28575618-caca-49d6-84a0-2c22d54c5f5a"
      ]
    },
    "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": "46ac7da1-d7b5-45e6-bd85-08faf7cf61da",
      "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": "9fa6c459-56ae-47fc-aece-e739f2102c22",
      "id": "ad0332ce-e4d8-4cd1-89c3-57d5278d59c1"
    }
  }
}

Params

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