GET /v1/:facility_id/tenants/search
Search Tenants by phone number or account code.

Params

Param name Description
phone_number
optional

Phone number of the tenant. Either phonenumber or accountnumber is required, but not both.

Validations:

  • Must be a String
account_number
optional

Account number of the tenant. Either phonenumber or accountnumber is required, but not both.

Validations:

  • Must be a String

Examples

GET /v1/bee88580-ae7f-40ad-8871-8ff19c6a25c8/tenants/search
200
{
  "tenants": [
    {
      "id": "34720982-24e4-43eb-b71d-e64b4a718ac0",
      "account_number": 123456,
      "first_name": "Example tenant",
      "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": "[email protected]",
      "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:37:45.589-10:00",
      "gate_24_hour_access": false,
      "active": false,
      "tenant_account_kind_name": "Standard",
      "blocked_payments": false,
      "date_of_birth": null,
      "phone_numbers": [],
      "mailing_address": {
        "id": "454aab10-0078-4a6d-bdf7-5fb156b6f479",
        "address1": "60591934 Cheree Forge",
        "address2": null,
        "city": "North Cruzfurt",
        "state": "DE",
        "postal": "89980",
        "country": "US",
        "full_address": "60591934 Cheree Forge, 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": "454aab10-0078-4a6d-bdf7-5fb156b6f479",
          "address1": "60591934 Cheree Forge",
          "address2": null,
          "city": "North Cruzfurt",
          "state": "DE",
          "postal": "89980",
          "country": "US",
          "full_address": "60591934 Cheree Forge, 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": "bee88580-ae7f-40ad-8871-8ff19c6a25c8",
      "previous_ledger_ids": [],
      "lead_ids": [],
      "closed_lead_ids": [],
      "contact_ids": [],
      "support_case_ids": [],
      "event_ids": [],
      "password_recovery_question_ids": [
        "c0698802-8cc1-4a2e-99c0-1373359d132f",
        "24b8de8d-dd0e-471c-8589-0cc9dfe55e54"
      ]
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "total_pages": 1,
      "per_page": 100,
      "total_entries": 1,
      "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": {
      "account_number": "[FILTERED]",
      "facility_id": "bee88580-ae7f-40ad-8871-8ff19c6a25c8",
      "tenant": {}
    }
  }
}