Company Leads (Company Level)

>>>

GET /v1/companies/:company_id/leads
Show all leads

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.

Examples

GET /v1/companies/02ec3527-59c5-4e01-a6b8-fdf9e4864014/leads
200
{
  "leads": [
    {
      "id": "c9cde275-66df-404e-97e1-77c9d21a0091",
      "bilingual_agent": false,
      "caller_first_name": null,
      "caller_last_name": null,
      "cancelled_at": null,
      "closed": false,
      "confirmation_number": null,
      "created_at": "2023-09-15T04:36:22.079-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": "e55032f9-821a-471c-988d-8ab09faa1900",
      "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:36:22.079-10:00",
      "status": "created",
      "tenant_id": "25067a89-0fb3-4c13-8ccb-0b9268571493",
      "urgent": false,
      "wait_list": false,
      "wait_list_available": false,
      "within_reservation_window": true,
      "is_upgrade": null,
      "desired_unit_size_and_amenities": null,
      "tenant": {
        "id": "25067a89-0fb3-4c13-8ccb-0b9268571493",
        "account_number": 1000003,
        "first_name": "Davis25",
        "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_25",
        "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:36:22.064-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": "d73a3e9f-0ea5-4df4-91db-a6b97cfe299c",
          "address1": "10974711 Corwin Haven",
          "address2": null,
          "city": "North Cruzfurt",
          "state": "DE",
          "postal": "89980",
          "country": "US",
          "full_address": "10974711 Corwin Haven, 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": "d73a3e9f-0ea5-4df4-91db-a6b97cfe299c",
            "address1": "10974711 Corwin Haven",
            "address2": null,
            "city": "North Cruzfurt",
            "state": "DE",
            "postal": "89980",
            "country": "US",
            "full_address": "10974711 Corwin Haven, 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": "e55032f9-821a-471c-988d-8ab09faa1900",
        "previous_ledger_ids": [],
        "closed_lead_ids": [],
        "contact_ids": [],
        "support_case_ids": [],
        "event_ids": [],
        "password_recovery_question_ids": [
          "22d4dbc8-7bd1-4bf6-bc66-fb542b13b800",
          "fcf93920-645b-465e-8435-cef30526ee3a"
        ]
      },
      "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": null,
      "channel_id": null,
      "confirmation_email": null
    },
    {
      "id": "26c92aef-50a7-43b9-8c96-fd2b7111de65",
      "bilingual_agent": false,
      "caller_first_name": null,
      "caller_last_name": null,
      "cancelled_at": null,
      "closed": false,
      "confirmation_number": null,
      "created_at": "2023-09-15T04:36:22.052-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": "8957d8af-f6dd-4cc4-acbc-2adf651cc4a4",
      "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-17T04:36:22.021-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:36:22.052-10:00",
      "status": "created",
      "tenant_id": "1db41bdf-cc53-4dff-880b-15cdc2a7d35c",
      "urgent": false,
      "wait_list": false,
      "wait_list_available": false,
      "within_reservation_window": true,
      "is_upgrade": null,
      "desired_unit_size_and_amenities": null,
      "tenant": {
        "id": "1db41bdf-cc53-4dff-880b-15cdc2a7d35c",
        "account_number": 1000002,
        "first_name": "Florentino24",
        "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_24",
        "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:36:22.031-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": "01c988f3-9a97-4085-ae45-5dbb4cdda9c4",
          "address1": "10862709 Loan Loaf",
          "address2": null,
          "city": "North Cruzfurt",
          "state": "DE",
          "postal": "89980",
          "country": "US",
          "full_address": "10862709 Loan Loaf, 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": "01c988f3-9a97-4085-ae45-5dbb4cdda9c4",
            "address1": "10862709 Loan Loaf",
            "address2": null,
            "city": "North Cruzfurt",
            "state": "DE",
            "postal": "89980",
            "country": "US",
            "full_address": "10862709 Loan Loaf, 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": "8957d8af-f6dd-4cc4-acbc-2adf651cc4a4",
        "previous_ledger_ids": [],
        "closed_lead_ids": [],
        "contact_ids": [],
        "support_case_ids": [],
        "event_ids": [],
        "password_recovery_question_ids": [
          "c1c94eb2-6d64-42a7-8314-57f526592217",
          "66203044-8994-4e03-9321-5ed0730bdf60"
        ]
      },
      "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": null,
      "channel_id": null,
      "confirmation_email": null
    },
    {
      "id": "e54f6381-30c2-46ff-b14c-0df37e8ae501",
      "bilingual_agent": false,
      "caller_first_name": null,
      "caller_last_name": null,
      "cancelled_at": null,
      "closed": false,
      "confirmation_number": "1000001-1-2592",
      "created_at": "2023-09-15T04:36:21.963-10:00",
      "desired_move_in_date": "2023-09-15",
      "desired_unit_size_and_price": "10x6x4 at $764.95",
      "due_at_move_in": 407.97,
      "due_monthly": 764.95,
      "extra_details": {
        "snapshot_reservation_id": "dab856d6-4cf2-4ea9-9c77-f73816122c5f"
      },
      "facility_id": "8957d8af-f6dd-4cc4-acbc-2adf651cc4a4",
      "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:36:21.980-10:00",
      "size": "10x6x4",
      "source_id": null,
      "source_name": null,
      "standard_rate": null,
      "started_at": "2023-09-15T04:36:21.963-10:00",
      "status": "reserved",
      "tenant_id": "78ac9de3-a25e-46d4-9ba2-124faa6ad567",
      "urgent": false,
      "wait_list": false,
      "wait_list_available": false,
      "within_reservation_window": true,
      "is_upgrade": null,
      "desired_unit_size_and_amenities": null,
      "tenant": {
        "id": "78ac9de3-a25e-46d4-9ba2-124faa6ad567",
        "account_number": 1000001,
        "first_name": "Joe23",
        "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_23",
        "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:36:21.929-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": "baeada17-b0ad-47c1-a42a-3c9e7c7dead0",
          "address1": "10771265 Evita Path",
          "address2": null,
          "city": "North Cruzfurt",
          "state": "DE",
          "postal": "89980",
          "country": "US",
          "full_address": "10771265 Evita Path, 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": "baeada17-b0ad-47c1-a42a-3c9e7c7dead0",
            "address1": "10771265 Evita Path",
            "address2": null,
            "city": "North Cruzfurt",
            "state": "DE",
            "postal": "89980",
            "country": "US",
            "full_address": "10771265 Evita Path, 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": "8957d8af-f6dd-4cc4-acbc-2adf651cc4a4",
        "previous_ledger_ids": [],
        "closed_lead_ids": [],
        "contact_ids": [],
        "support_case_ids": [],
        "event_ids": [
          "8c978ea7-0194-4f34-a15f-e42670cb67d9"
        ],
        "password_recovery_question_ids": [
          "ed8601d0-f564-4406-8f97-53d275c20b5f",
          "c10cf4b1-76b1-44c0-a18f-8b0fe7ac89e0"
        ]
      },
      "unit": {
        "id": "0455c83d-91dc-4de3-99c3-b36b9a7dd0dc",
        "price": 764.95,
        "name": "U7",
        "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": "9a546e13-763a-47ef-bbcc-ad6b252b492a",
          "name": "Unit Type 7",
          "deleted": false,
          "internal_account_code": "4000",
          "code_and_description": "4000 - Rental Revenue",
          "ii_excluded": []
        },
        "tier": null,
        "unit_group_id": "a3c071d1-bca4-4f79-b84e-628ee67c18bf"
      },
      "length_of_stay": null,
      "successful_payment_events": [],
      "caller_phone_number": null,
      "unit_amenities": [],
      "current_user": null,
      "unit_type": {
        "id": "9a546e13-763a-47ef-bbcc-ad6b252b492a",
        "name": "Unit Type 7",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "close_reason": null,
      "discount_plans": [],
      "lead_contents": [],
      "unit_group": {
        "id": "a3c071d1-bca4-4f79-b84e-628ee67c18bf",
        "price": 764.95,
        "group_key": "10x6x4 - $764.95 - 3073",
        "name": "U7 - 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": "9a546e13-763a-47ef-bbcc-ad6b252b492a",
          "name": "Unit Type 7",
          "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": null,
      "channel_id": null,
      "confirmation_email": null
    },
    {
      "id": "209853b5-2d84-43c9-92e2-eed8d490fb7b",
      "bilingual_agent": false,
      "caller_first_name": null,
      "caller_last_name": null,
      "cancelled_at": null,
      "closed": false,
      "confirmation_number": null,
      "created_at": "2023-09-15T04:36:21.842-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": "8957d8af-f6dd-4cc4-acbc-2adf651cc4a4",
      "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:36:21.842-10:00",
      "status": "created",
      "tenant_id": "6a02b633-2c38-4220-b68d-83e855fba268",
      "urgent": false,
      "wait_list": false,
      "wait_list_available": false,
      "within_reservation_window": true,
      "is_upgrade": null,
      "desired_unit_size_and_amenities": null,
      "tenant": {
        "id": "6a02b633-2c38-4220-b68d-83e855fba268",
        "account_number": 1000000,
        "first_name": "Korey22",
        "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_22",
        "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:36:21.824-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": "5d6c472f-6d83-447b-acfb-13d6d8fd6ecc",
          "address1": "106506 Block Avenue",
          "address2": null,
          "city": "North Cruzfurt",
          "state": "DE",
          "postal": "89980",
          "country": "US",
          "full_address": "106506 Block Avenue, 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": "5d6c472f-6d83-447b-acfb-13d6d8fd6ecc",
            "address1": "106506 Block Avenue",
            "address2": null,
            "city": "North Cruzfurt",
            "state": "DE",
            "postal": "89980",
            "country": "US",
            "full_address": "106506 Block Avenue, 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": "8957d8af-f6dd-4cc4-acbc-2adf651cc4a4",
        "previous_ledger_ids": [],
        "closed_lead_ids": [],
        "contact_ids": [],
        "support_case_ids": [],
        "event_ids": [],
        "password_recovery_question_ids": [
          "e4047932-a0db-4dbf-bb6e-a2ab84a26c62",
          "ce97557b-e8b3-4904-8387-a3769870b226"
        ]
      },
      "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": null,
      "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": {
      "company_id": "02ec3527-59c5-4e01-a6b8-fdf9e4864014",
      "company_lead": {}
    }
  }
}
>>>

GET /v1/companies/:company_id/leads/current
Show all current leads

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.
>>>

GET /v1/companies/:company_id/leads/follow_up
Show all followup leads

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.
>>>

GET /v1/companies/:company_id/leads/reservations
Show all leads that are reservations

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.
>>>

GET /v1/companies/:company_id/leads/inquiries
Show all leads that are not reservations (inquiries)

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.
>>>

GET /v1/companies/:company_id/leads/missed_move_ins
Show all missed move ins

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.
>>>

GET /v1/companies/:company_id/leads/waitlist
Show all waitlist leads

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.
>>>

GET /v1/companies/:company_id/leads/open/events
Shows all lead events for open leads

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.
>>>

GET /v1/companies/:company_id/leads/counts
Shows a count of open leads by status (lead, reservation)

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.
>>>

GET /v1/companies/:company_id/leads/:id
Show a particular lead

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