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

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/companies/8f111703-02ca-4718-9e58-eb8aaf1fade7/leads
200
{
  "leads": [
    {
      "id": "6f7198a4-8f2b-4da7-b473-121624a253bb",
      "bilingual_agent": false,
      "caller_first_name": null,
      "caller_last_name": null,
      "cancelled_at": null,
      "closed": false,
      "confirmation_number": null,
      "created_at": "2022-09-12T22:37:00.435-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": "cac90da0-c2c1-4542-a78f-6167816eacbb",
      "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",
      "originating_client_application_id": "af13f660-7d53-0134-53d3-0ad9c40e81a9",
      "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:37:00.436-10:00",
      "status": "created",
      "tenant_id": "ff92feb6-5e2f-47cb-ba78-663f3f01c51c",
      "urgent": false,
      "wait_list": false,
      "wait_list_available": false,
      "within_reservation_window": true,
      "is_upgrade": null,
      "desired_unit_size_and_amenities": null,
      "tenant": {
        "id": "ff92feb6-5e2f-47cb-ba78-663f3f01c51c",
        "account_number": 1000003,
        "first_name": "Emerson104",
        "last_name": "Wehner",
        "middle_initial": null,
        "email": "tim@turner.biz106",
        "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_104",
        "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:00.420-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": "a49e5037-b6a1-46d9-a9c0-96cf0f05b244",
          "address1": "59028938 Gulgowski Ports",
          "address2": null,
          "city": "South Jessie",
          "state": "CT",
          "postal": "39384",
          "country": "US",
          "full_address": "59028938 Gulgowski Ports, 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": "a49e5037-b6a1-46d9-a9c0-96cf0f05b244",
            "address1": "59028938 Gulgowski Ports",
            "address2": null,
            "city": "South Jessie",
            "state": "CT",
            "postal": "39384",
            "country": "US",
            "full_address": "59028938 Gulgowski Ports, 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": "cac90da0-c2c1-4542-a78f-6167816eacbb",
        "previous_ledger_ids": [],
        "closed_lead_ids": [],
        "contact_ids": [],
        "support_case_ids": [],
        "event_ids": [],
        "password_recovery_question_ids": [
          "6892f134-739e-4167-8fe9-fc74f9057444",
          "c23de9ff-6c4e-40b8-a8b3-9a3fd6ec0e11"
        ]
      },
      "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": "0b7c00cc-4b0d-43fa-944d-b4240fccbf31",
      "bilingual_agent": false,
      "caller_first_name": null,
      "caller_last_name": null,
      "cancelled_at": null,
      "closed": false,
      "confirmation_number": null,
      "created_at": "2022-09-12T22:37:00.412-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": "b6579afe-a10b-41a6-a432-3b728e1ae1aa",
      "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-14T22:37:00.390-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:37:00.412-10:00",
      "status": "created",
      "tenant_id": "1062d0e0-1588-4c55-8a55-053a85a17fbe",
      "urgent": false,
      "wait_list": false,
      "wait_list_available": false,
      "within_reservation_window": true,
      "is_upgrade": null,
      "desired_unit_size_and_amenities": null,
      "tenant": {
        "id": "1062d0e0-1588-4c55-8a55-053a85a17fbe",
        "account_number": 1000002,
        "first_name": "Chung103",
        "last_name": "Wehner",
        "middle_initial": null,
        "email": "rubinbarton@johnston.org105",
        "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_103",
        "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:00.397-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": "2f3c5ce6-7439-43b4-85ea-087c74fa3d19",
          "address1": "589229 Kevin Gardens",
          "address2": null,
          "city": "South Jessie",
          "state": "CT",
          "postal": "39384",
          "country": "US",
          "full_address": "589229 Kevin Gardens, 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": "2f3c5ce6-7439-43b4-85ea-087c74fa3d19",
            "address1": "589229 Kevin Gardens",
            "address2": null,
            "city": "South Jessie",
            "state": "CT",
            "postal": "39384",
            "country": "US",
            "full_address": "589229 Kevin Gardens, 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": "b6579afe-a10b-41a6-a432-3b728e1ae1aa",
        "previous_ledger_ids": [],
        "closed_lead_ids": [],
        "contact_ids": [],
        "support_case_ids": [],
        "event_ids": [],
        "password_recovery_question_ids": [
          "505f9aa5-1e0c-4463-9aba-c786017cd5ec",
          "9cdec8e9-02b0-4ec6-b5fb-230b8bf1699e"
        ]
      },
      "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": "e876dbd5-ca16-4cd9-8dbf-c376380a0784",
      "bilingual_agent": false,
      "caller_first_name": null,
      "caller_last_name": null,
      "cancelled_at": null,
      "closed": false,
      "confirmation_number": "1000001-1-1712",
      "created_at": "2022-09-12T22:37:00.363-10:00",
      "desired_move_in_date": "2022-09-12",
      "desired_unit_size_and_price": "8x5x7 at $847.75",
      "due_at_move_in": 536.91,
      "due_monthly": 847.75,
      "extra_details": {
        "snapshot_reservation_id": "7a008ddb-f71c-4618-b17a-ba50f65d7116"
      },
      "facility_id": "b6579afe-a10b-41a6-a432-3b728e1ae1aa",
      "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:00.368-10:00",
      "size": "8x5x7",
      "source_id": null,
      "source_name": null,
      "standard_rate": null,
      "started_at": "2022-09-12T22:37:00.363-10:00",
      "status": "reserved",
      "tenant_id": "a8d6a36d-29dd-4c15-9da0-7afed8bad5ed",
      "urgent": false,
      "wait_list": false,
      "wait_list_available": false,
      "within_reservation_window": true,
      "is_upgrade": null,
      "desired_unit_size_and_amenities": null,
      "tenant": {
        "id": "a8d6a36d-29dd-4c15-9da0-7afed8bad5ed",
        "account_number": 1000001,
        "first_name": "Frankie102",
        "last_name": "Wehner",
        "middle_initial": null,
        "email": "vanetta@heller.co104",
        "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_102",
        "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:00.345-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": "7dd65b21-f30a-4a0e-a4c1-12176904feed",
          "address1": "58818511 Kerluke Hollow",
          "address2": null,
          "city": "South Jessie",
          "state": "CT",
          "postal": "39384",
          "country": "US",
          "full_address": "58818511 Kerluke Hollow, 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": "7dd65b21-f30a-4a0e-a4c1-12176904feed",
            "address1": "58818511 Kerluke Hollow",
            "address2": null,
            "city": "South Jessie",
            "state": "CT",
            "postal": "39384",
            "country": "US",
            "full_address": "58818511 Kerluke Hollow, 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": "b6579afe-a10b-41a6-a432-3b728e1ae1aa",
        "previous_ledger_ids": [],
        "closed_lead_ids": [],
        "contact_ids": [],
        "support_case_ids": [],
        "event_ids": [
          "4406b5b0-2ecd-4b08-b163-5c3c86999488"
        ],
        "password_recovery_question_ids": [
          "110c4525-7dc1-471e-a101-eb97c0152be5",
          "f4113c62-6375-4b05-92a8-cf38d6af4f6a"
        ]
      },
      "unit": {
        "id": "1c662ad8-f2c4-48db-8779-c4138cf64648",
        "price": 847.75,
        "name": "U105",
        "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": 2028,
          "descriptor": "No Tier",
          "tiered_amenities": []
        },
        "custom_fields": [],
        "channel_rate": null,
        "unit_amenities": [],
        "unit_type": {
          "id": "be67d669-3c68-4850-b556-e7a6bf0ad1f4",
          "name": "Unit Type 109",
          "deleted": false,
          "internal_account_code": "4000",
          "code_and_description": "4000 - Rental Revenue",
          "ii_excluded": []
        },
        "unit_group_id": "158609f4-fcaf-4a88-bc9f-89cf7540c999"
      },
      "length_of_stay": null,
      "successful_payment_events": [],
      "caller_phone_number": null,
      "unit_amenities": [],
      "current_user": null,
      "unit_type": {
        "id": "be67d669-3c68-4850-b556-e7a6bf0ad1f4",
        "name": "Unit Type 109",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "close_reason": null,
      "discount_plans": [],
      "lead_contents": [],
      "unit_group": {
        "id": "158609f4-fcaf-4a88-bc9f-89cf7540c999",
        "price": 847.75,
        "group_key": "8x5x7 - $847.75 - 2079",
        "name": "8x5x7 - $847.75 - 2079",
        "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": 2028,
          "descriptor": "No Tier",
          "justification": null,
          "tiered_amenities": []
        },
        "channel_rate": null,
        "unit_amenities": [],
        "unit_type": {
          "id": "be67d669-3c68-4850-b556-e7a6bf0ad1f4",
          "name": "Unit Type 109",
          "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": "4da98f44-6d6d-43c2-9486-b263b11b745c",
      "bilingual_agent": false,
      "caller_first_name": null,
      "caller_last_name": null,
      "cancelled_at": null,
      "closed": false,
      "confirmation_number": null,
      "created_at": "2022-09-12T22:37:00.302-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": "b6579afe-a10b-41a6-a432-3b728e1ae1aa",
      "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": "2022-09-12T22:37:00.302-10:00",
      "status": "created",
      "tenant_id": "f5728534-1932-4d34-9d19-0c2d1ccf53f7",
      "urgent": false,
      "wait_list": false,
      "wait_list_available": false,
      "within_reservation_window": true,
      "is_upgrade": null,
      "desired_unit_size_and_amenities": null,
      "tenant": {
        "id": "f5728534-1932-4d34-9d19-0c2d1ccf53f7",
        "account_number": 1000000,
        "first_name": "Alexis101",
        "last_name": "Wehner",
        "middle_initial": null,
        "email": "adriannehayes@cummings.org103",
        "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_101",
        "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:00.286-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": "48bac510-ea0f-48d2-b837-95542b3aaa54",
          "address1": "58761721 Schowalter Fords",
          "address2": null,
          "city": "South Jessie",
          "state": "CT",
          "postal": "39384",
          "country": "US",
          "full_address": "58761721 Schowalter Fords, 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": "48bac510-ea0f-48d2-b837-95542b3aaa54",
            "address1": "58761721 Schowalter Fords",
            "address2": null,
            "city": "South Jessie",
            "state": "CT",
            "postal": "39384",
            "country": "US",
            "full_address": "58761721 Schowalter Fords, 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": "b6579afe-a10b-41a6-a432-3b728e1ae1aa",
        "previous_ledger_ids": [],
        "closed_lead_ids": [],
        "contact_ids": [],
        "support_case_ids": [],
        "event_ids": [],
        "password_recovery_question_ids": [
          "27376642-779c-4da9-87d5-afcf887690b4",
          "3dc3be6c-8f76-4374-bded-5e1e4ceb3da1"
        ]
      },
      "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": "8f111703-02ca-4718-9e58-eb8aaf1fade7"
    }
  }
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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