Params

Param name Description
id
required

Validations:

  • Must be a String

Examples

GET /v1/ff6ce16b-381f-442f-a49a-01cdb99ec65e/tenants/c868b194-836f-4884-bda9-d8eed5329eaa
200
{
  "tenant": {
    "id": "c868b194-836f-4884-bda9-d8eed5329eaa",
    "account_number": 1000000,
    "first_name": "Harold76",
    "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": [
      "29e0ac71-4f68-419c-a732-5e3f740f3812"
    ],
    "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_76",
    "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:36.405-10:00",
    "gate_24_hour_access": false,
    "active": true,
    "tenant_account_kind_name": "Standard",
    "blocked_payments": false,
    "date_of_birth": null,
    "phone_numbers": [
      {
        "id": "31e1c516-1870-42d2-93f3-f9909a140a1d",
        "primary": true,
        "source": null,
        "number": "+15207041751",
        "formatted_number": "(520) 704-1751 x 6844",
        "extension": "6844",
        "label": "Fax",
        "unformatted_number": "5207041751",
        "sms_opt_in": false
      },
      {
        "id": "405e6655-dd1f-40bc-a1c5-ed60ba6eab3a",
        "primary": false,
        "source": null,
        "number": "+14153371956",
        "formatted_number": "(415) 337-1956",
        "extension": null,
        "label": "Mobile",
        "unformatted_number": "4153371956",
        "sms_opt_in": false
      },
      {
        "id": "c4a41a43-7c7b-46db-b5db-c9481fbb2bda",
        "primary": false,
        "source": null,
        "number": "+14358179755",
        "formatted_number": "(435) 817-9755",
        "extension": null,
        "label": "Pager",
        "unformatted_number": "4358179755",
        "sms_opt_in": false
      }
    ],
    "mailing_address": {
      "id": "8020e5fc-cbdc-4a63-917c-10cf42b995bb",
      "address1": "53622282 Marcella Fields",
      "address2": null,
      "city": "North Cruzfurt",
      "state": "DE",
      "postal": "89980",
      "country": "US",
      "full_address": "53622282 Marcella Fields, 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": "8020e5fc-cbdc-4a63-917c-10cf42b995bb",
        "address1": "53622282 Marcella Fields",
        "address2": null,
        "city": "North Cruzfurt",
        "state": "DE",
        "postal": "89980",
        "country": "US",
        "full_address": "53622282 Marcella Fields, 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": "ff6ce16b-381f-442f-a49a-01cdb99ec65e",
    "previous_ledger_ids": [],
    "lead_ids": [],
    "closed_lead_ids": [],
    "contact_ids": [
      "772e29cd-6841-4eef-8391-94cfee12a929"
    ],
    "support_case_ids": [],
    "event_ids": [
      "58a945a7-e0c3-4b1c-b505-a7e156e6b1f0",
      "5287bb34-45c8-4f86-bdb6-197d7ff9c240"
    ],
    "password_recovery_question_ids": [
      "eb4551b8-20ce-4feb-ba41-35177c349956",
      "b3e4f276-700d-4f71-982a-cebebc922ab2"
    ]
  },
  "meta": {
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "GET",
    "request_id": null,
    "parameters": {
      "facility_id": "ff6ce16b-381f-442f-a49a-01cdb99ec65e",
      "id": "c868b194-836f-4884-bda9-d8eed5329eaa",
      "tenant": {}
    }
  }
}