GET v2/facilities/{facilityId}/tenant?tenantId={tenantId}&tenantPin={tenantPin}&unitName={unitName}&phoneLast4={phoneLast4}&lastName={lastName}

Gets the tenant information. This is a new API for K2, to support retrieving tenant info using the info supported by K1 when a full Tenant List isn't available so tenantId isn't known.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
facilityId

The facility identifier.

globally unique identifier

Required

tenantId

The tenant identifier.

string

Default value is

tenantPin

The tenant pin - generally gate code.

string

Default value is

unitName

The unit name (as opposed to the unit id).

string

Default value is

phoneLast4

The last 4 digits of the tenant phone, if that's what this facility is configured to use for auth.

string

Default value is

lastName

The tenant last name, if that's what this facility is configured to use for auth.

string

Default value is

Body Parameters

None.

Response Information

Resource Description

FacilityTenantInfo
NameDescriptionTypeAdditional information
Id

string

None.

GateAccessCode

string

None.

CompanyName

string

None.

FirstName

string

None.

MiddleName

string

None.

LastName

string

None.

Street1

string

None.

Street2

string

None.

City

string

None.

StateOrProv

string

None.

PostalCode

string

None.

Country

string

None.

HomePhone

string

None.

WorkPhone

string

None.

CellPhone

string

None.

EmailAddress

string

None.

VehicleType

string

None.

VehiclePlate

string

None.

PayType

string

None.

CreditCardType

string

None.

CreditCardNameOnIt

string

None.

CreditCardNumber

string

None.

CreditCardExpMo

string

None.

CreditCardExpYear

string

None.

DriversLicenseNumber

string

None.

DriversLicenseState

string

None.

BillingStreet1

string

None.

BillingStreet2

string

None.

BillingCity

string

None.

BillingStateOrProv

string

None.

BillingPostalCode

string

None.

BillingCountry

string

None.

AlternateContactFirstName

string

None.

AlternateContactLastName

string

None.

AlternateContactStreet1

string

None.

AlternateContactStreet2

string

None.

AlternateContactCity

string

None.

AlternateContactStateOrProv

string

None.

AlternateContactPostalCode

string

None.

AlternateContactCountry

string

None.

AlternateContactPhone

string

None.

MilitaryFlag

boolean

None.

MilitaryBase

string

None.

MilitaryContactName

string

None.

MilitaryContactPhone

string

None.

SocialSecurityNumber

string

None.

Status

string

None.

NoCheckAllowed

boolean

None.

WebPassword

string

None.

DateOfBirth

date

None.

BillingPeriod

string

None.

Errors

Collection of Exception

None.

IsSuccess

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "sample string 1",
  "GateAccessCode": "sample string 2",
  "CompanyName": "sample string 3",
  "FirstName": "sample string 4",
  "MiddleName": "sample string 5",
  "LastName": "sample string 6",
  "Street1": "sample string 7",
  "Street2": "sample string 8",
  "City": "sample string 9",
  "StateOrProv": "sample string 10",
  "PostalCode": "sample string 11",
  "Country": "sample string 12",
  "HomePhone": "sample string 13",
  "WorkPhone": "sample string 14",
  "CellPhone": "sample string 15",
  "EmailAddress": "sample string 16",
  "VehicleType": "sample string 17",
  "VehiclePlate": "sample string 18",
  "PayType": "sample string 19",
  "CreditCardType": "sample string 20",
  "CreditCardNameOnIt": "sample string 21",
  "CreditCardNumber": "sample string 22",
  "CreditCardExpMo": "sample string 23",
  "CreditCardExpYear": "sample string 24",
  "DriversLicenseNumber": "sample string 25",
  "DriversLicenseState": "sample string 26",
  "BillingStreet1": "sample string 27",
  "BillingStreet2": "sample string 28",
  "BillingCity": "sample string 29",
  "BillingStateOrProv": "sample string 30",
  "BillingPostalCode": "sample string 31",
  "BillingCountry": "sample string 32",
  "AlternateContactFirstName": "sample string 33",
  "AlternateContactLastName": "sample string 34",
  "AlternateContactStreet1": "sample string 35",
  "AlternateContactStreet2": "sample string 36",
  "AlternateContactCity": "sample string 37",
  "AlternateContactStateOrProv": "sample string 38",
  "AlternateContactPostalCode": "sample string 39",
  "AlternateContactCountry": "sample string 40",
  "AlternateContactPhone": "sample string 41",
  "MilitaryFlag": true,
  "MilitaryBase": "sample string 43",
  "MilitaryContactName": "sample string 44",
  "MilitaryContactPhone": "sample string 45",
  "SocialSecurityNumber": "sample string 46",
  "Status": "sample string 47",
  "NoCheckAllowed": true,
  "WebPassword": "sample string 49",
  "DateOfBirth": "2025-06-30T23:19:58.2515605-07:00",
  "BillingPeriod": "sample string 50",
  "Errors": [
    {
      "ClassName": "System.Exception",
      "Message": null,
      "Data": null,
      "InnerException": null,
      "HelpURL": "sample string 1",
      "StackTraceString": null,
      "RemoteStackTraceString": null,
      "RemoteStackIndex": 0,
      "ExceptionMethod": null,
      "HResult": 3,
      "Source": "sample string 2",
      "WatsonBuckets": null
    },
    {
      "ClassName": "System.Exception",
      "Message": null,
      "Data": null,
      "InnerException": null,
      "HelpURL": "sample string 1",
      "StackTraceString": null,
      "RemoteStackTraceString": null,
      "RemoteStackIndex": 0,
      "ExceptionMethod": null,
      "HResult": 3,
      "Source": "sample string 2",
      "WatsonBuckets": null
    }
  ],
  "IsSuccess": true
}

application/xml, text/xml

Sample:
<FacilityTenantInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models.BindingModels">
  <Errors xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:Exception>
      <ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName>
      <Message i:nil="true" xmlns="" />
      <Data i:nil="true" xmlns="" />
      <InnerException i:nil="true" xmlns="" />
      <HelpURL xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 1</HelpURL>
      <StackTraceString i:nil="true" xmlns="" />
      <RemoteStackTraceString i:nil="true" xmlns="" />
      <RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex>
      <ExceptionMethod i:nil="true" xmlns="" />
      <HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">3</HResult>
      <Source xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 2</Source>
      <WatsonBuckets i:nil="true" xmlns="" />
    </d2p1:Exception>
    <d2p1:Exception>
      <ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName>
      <Message i:nil="true" xmlns="" />
      <Data i:nil="true" xmlns="" />
      <InnerException i:nil="true" xmlns="" />
      <HelpURL xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 1</HelpURL>
      <StackTraceString i:nil="true" xmlns="" />
      <RemoteStackTraceString i:nil="true" xmlns="" />
      <RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex>
      <ExceptionMethod i:nil="true" xmlns="" />
      <HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">3</HResult>
      <Source xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 2</Source>
      <WatsonBuckets i:nil="true" xmlns="" />
    </d2p1:Exception>
  </Errors>
  <IsSuccess>true</IsSuccess>
  <AlternateContactCity>sample string 37</AlternateContactCity>
  <AlternateContactCountry>sample string 40</AlternateContactCountry>
  <AlternateContactFirstName>sample string 33</AlternateContactFirstName>
  <AlternateContactLastName>sample string 34</AlternateContactLastName>
  <AlternateContactPhone>sample string 41</AlternateContactPhone>
  <AlternateContactPostalCode>sample string 39</AlternateContactPostalCode>
  <AlternateContactStateOrProv>sample string 38</AlternateContactStateOrProv>
  <AlternateContactStreet1>sample string 35</AlternateContactStreet1>
  <AlternateContactStreet2>sample string 36</AlternateContactStreet2>
  <BillingCity>sample string 29</BillingCity>
  <BillingCountry>sample string 32</BillingCountry>
  <BillingPeriod>sample string 50</BillingPeriod>
  <BillingPostalCode>sample string 31</BillingPostalCode>
  <BillingStateOrProv>sample string 30</BillingStateOrProv>
  <BillingStreet1>sample string 27</BillingStreet1>
  <BillingStreet2>sample string 28</BillingStreet2>
  <CellPhone>sample string 15</CellPhone>
  <City>sample string 9</City>
  <CompanyName>sample string 3</CompanyName>
  <Country>sample string 12</Country>
  <CreditCardExpMo>sample string 23</CreditCardExpMo>
  <CreditCardExpYear>sample string 24</CreditCardExpYear>
  <CreditCardNameOnIt>sample string 21</CreditCardNameOnIt>
  <CreditCardNumber>sample string 22</CreditCardNumber>
  <CreditCardType>sample string 20</CreditCardType>
  <DateOfBirth>2025-06-30T23:19:58.2515605-07:00</DateOfBirth>
  <DriversLicenseNumber>sample string 25</DriversLicenseNumber>
  <DriversLicenseState>sample string 26</DriversLicenseState>
  <EmailAddress>sample string 16</EmailAddress>
  <FirstName>sample string 4</FirstName>
  <GateAccessCode>sample string 2</GateAccessCode>
  <HomePhone>sample string 13</HomePhone>
  <Id>sample string 1</Id>
  <LastName>sample string 6</LastName>
  <MiddleName>sample string 5</MiddleName>
  <MilitaryBase>sample string 43</MilitaryBase>
  <MilitaryContactName>sample string 44</MilitaryContactName>
  <MilitaryContactPhone>sample string 45</MilitaryContactPhone>
  <MilitaryFlag>true</MilitaryFlag>
  <NoCheckAllowed>true</NoCheckAllowed>
  <PayType>sample string 19</PayType>
  <PostalCode>sample string 11</PostalCode>
  <SocialSecurityNumber>sample string 46</SocialSecurityNumber>
  <StateOrProv>sample string 10</StateOrProv>
  <Status>sample string 47</Status>
  <Street1>sample string 7</Street1>
  <Street2>sample string 8</Street2>
  <VehiclePlate>sample string 18</VehiclePlate>
  <VehicleType>sample string 17</VehicleType>
  <WebPassword>sample string 49</WebPassword>
  <WorkPhone>sample string 14</WorkPhone>
</FacilityTenantInfo>