POST /v1/:facility_id/tenants/username_lookup
Lookup tenant based on username

Examples

POST /v1/7de94f93-58a2-482b-92fd-f3b0da57a174/tenants/username_lookup
{
  "username": "exampleuser@someone.com"
}
200
{
  "tenant": {
    "id": "c965cd0c-0f11-46f7-90cb-aace9584c274",
    "account_number": 1000002,
    "first_name": "Example tenant",
    "last_name": "Wehner",
    "middle_initial": null,
    "email": "amie@harber.org92",
    "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": "exampleuser@someone.com",
    "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:50.528-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": "7adfc81c-8f95-4326-b798-2c17ab869c91",
      "address1": "455847 Heidenreich Circles",
      "address2": null,
      "city": "South Jessie",
      "state": "CT",
      "postal": "39384",
      "country": "US",
      "full_address": "455847 Heidenreich Circles, 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": "7adfc81c-8f95-4326-b798-2c17ab869c91",
        "address1": "455847 Heidenreich Circles",
        "address2": null,
        "city": "South Jessie",
        "state": "CT",
        "postal": "39384",
        "country": "US",
        "full_address": "455847 Heidenreich Circles, 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": "7de94f93-58a2-482b-92fd-f3b0da57a174",
    "previous_ledger_ids": [],
    "lead_ids": [],
    "closed_lead_ids": [],
    "contact_ids": [],
    "support_case_ids": [],
    "event_ids": [],
    "password_recovery_question_ids": [
      "067700de-8897-41a6-b85a-94481b5fe6f4",
      "2746160d-2467-46fe-b8bf-27f49d4ce981"
    ]
  },
  "meta": {
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "POST",
    "request_id": null,
    "parameters": {
      "username": "exampleuser@someone.com",
      "facility_id": "7de94f93-58a2-482b-92fd-f3b0da57a174"
    }
  }
}

Params