GET v2/facilities/{id}/findTenant?FirstName={FirstName}&LastName={LastName}&Address={Address}&City={City}&PostalCode={PostalCode}&Phone={Phone}&Email={Email}&GateCode={GateCode}&UnitName={UnitName}&AcrossAccount={AcrossAccount}

Gets the tenants by search criteria and returns extended tenant objects that contain the facility ID.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The identifier.	globally unique identifier	Required
FirstName		string	None.
LastName		string	None.
Address		string	None.
City		string	None.
PostalCode		string	None.
Phone		string	None.
Email		string	None.
GateCode		string	None.
UnitName		string	None.
AcrossAccount		string	None.

Body Parameters

None.

Response Information

Resource Description

FacilityTenantsV2

Name	Type	Additional information
FacilityTenantsList	Collection of FacilityTenantItemV2	None.
Errors	Collection of Exception	None.
IsSuccess	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "FacilityTenantsList": [
    {
      "FacilityId": "484cde78-24bf-44b5-8f44-b7f6e168f4d1",
      "Id": "sample string 2",
      "FirstName": "sample string 3",
      "MiddleName": "sample string 4",
      "LastName": "sample string 5",
      "Street1": "sample string 6",
      "Street2": "sample string 7",
      "City": "sample string 8",
      "StateOrProv": "sample string 9",
      "PostalCode": "sample string 10",
      "HomePhone": "sample string 11",
      "WorkPhone": "sample string 12",
      "CellPhone": "sample string 13",
      "EmailAddress": "sample string 14",
      "GateAccessCode": "sample string 15",
      "UnitId": "sample string 16",
      "UnitName": "sample string 17",
      "UnitPaidThruDate": "2025-06-30T15:10:19.1611731-07:00",
      "UnitBalanceDue": 19.1,
      "UnitRentalRate": 1.1,
      "BillingPeriod": "sample string 20",
      "LastPTDUpdated": "2025-06-30T15:10:19.1611731-07:00",
      "OverLocked": "sample string 21",
      "GateLocked": "sample string 22",
      "MovedInDate": "2025-06-30T15:10:19.1611731-07:00",
      "ExpectedVacateDate": "2025-06-30T15:10:19.1611731-07:00",
      "NextRentAssessmentDate": "2025-06-30T15:10:19.1611731-07:00"
    },
    {
      "FacilityId": "484cde78-24bf-44b5-8f44-b7f6e168f4d1",
      "Id": "sample string 2",
      "FirstName": "sample string 3",
      "MiddleName": "sample string 4",
      "LastName": "sample string 5",
      "Street1": "sample string 6",
      "Street2": "sample string 7",
      "City": "sample string 8",
      "StateOrProv": "sample string 9",
      "PostalCode": "sample string 10",
      "HomePhone": "sample string 11",
      "WorkPhone": "sample string 12",
      "CellPhone": "sample string 13",
      "EmailAddress": "sample string 14",
      "GateAccessCode": "sample string 15",
      "UnitId": "sample string 16",
      "UnitName": "sample string 17",
      "UnitPaidThruDate": "2025-06-30T15:10:19.1611731-07:00",
      "UnitBalanceDue": 19.1,
      "UnitRentalRate": 1.1,
      "BillingPeriod": "sample string 20",
      "LastPTDUpdated": "2025-06-30T15:10:19.1611731-07:00",
      "OverLocked": "sample string 21",
      "GateLocked": "sample string 22",
      "MovedInDate": "2025-06-30T15:10:19.1611731-07:00",
      "ExpectedVacateDate": "2025-06-30T15:10:19.1611731-07:00",
      "NextRentAssessmentDate": "2025-06-30T15:10:19.1611731-07:00"
    }
  ],
  "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:

<FacilityTenantsV2 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>
  <FacilityTenantsList>
    <FacilityTenantItemV2>
      <BillingPeriod>sample string 20</BillingPeriod>
      <CellPhone>sample string 13</CellPhone>
      <City>sample string 8</City>
      <EmailAddress>sample string 14</EmailAddress>
      <ExpectedVacateDate>2025-06-30T15:10:19.1611731-07:00</ExpectedVacateDate>
      <FacilityId>484cde78-24bf-44b5-8f44-b7f6e168f4d1</FacilityId>
      <FirstName>sample string 3</FirstName>
      <GateAccessCode>sample string 15</GateAccessCode>
      <GateLocked>sample string 22</GateLocked>
      <HomePhone>sample string 11</HomePhone>
      <Id>sample string 2</Id>
      <LastName>sample string 5</LastName>
      <LastPTDUpdated>2025-06-30T15:10:19.1611731-07:00</LastPTDUpdated>
      <MiddleName>sample string 4</MiddleName>
      <MovedInDate>2025-06-30T15:10:19.1611731-07:00</MovedInDate>
      <NextRentAssessmentDate>2025-06-30T15:10:19.1611731-07:00</NextRentAssessmentDate>
      <OverLocked>sample string 21</OverLocked>
      <PostalCode>sample string 10</PostalCode>
      <StateOrProv>sample string 9</StateOrProv>
      <Street1>sample string 6</Street1>
      <Street2>sample string 7</Street2>
      <UnitBalanceDue>19.1</UnitBalanceDue>
      <UnitId>sample string 16</UnitId>
      <UnitName>sample string 17</UnitName>
      <UnitPaidThruDate>2025-06-30T15:10:19.1611731-07:00</UnitPaidThruDate>
      <UnitRentalRate>1.1</UnitRentalRate>
      <WorkPhone>sample string 12</WorkPhone>
    </FacilityTenantItemV2>
    <FacilityTenantItemV2>
      <BillingPeriod>sample string 20</BillingPeriod>
      <CellPhone>sample string 13</CellPhone>
      <City>sample string 8</City>
      <EmailAddress>sample string 14</EmailAddress>
      <ExpectedVacateDate>2025-06-30T15:10:19.1611731-07:00</ExpectedVacateDate>
      <FacilityId>484cde78-24bf-44b5-8f44-b7f6e168f4d1</FacilityId>
      <FirstName>sample string 3</FirstName>
      <GateAccessCode>sample string 15</GateAccessCode>
      <GateLocked>sample string 22</GateLocked>
      <HomePhone>sample string 11</HomePhone>
      <Id>sample string 2</Id>
      <LastName>sample string 5</LastName>
      <LastPTDUpdated>2025-06-30T15:10:19.1611731-07:00</LastPTDUpdated>
      <MiddleName>sample string 4</MiddleName>
      <MovedInDate>2025-06-30T15:10:19.1611731-07:00</MovedInDate>
      <NextRentAssessmentDate>2025-06-30T15:10:19.1611731-07:00</NextRentAssessmentDate>
      <OverLocked>sample string 21</OverLocked>
      <PostalCode>sample string 10</PostalCode>
      <StateOrProv>sample string 9</StateOrProv>
      <Street1>sample string 6</Street1>
      <Street2>sample string 7</Street2>
      <UnitBalanceDue>19.1</UnitBalanceDue>
      <UnitId>sample string 16</UnitId>
      <UnitName>sample string 17</UnitName>
      <UnitPaidThruDate>2025-06-30T15:10:19.1611731-07:00</UnitPaidThruDate>
      <UnitRentalRate>1.1</UnitRentalRate>
      <WorkPhone>sample string 12</WorkPhone>
    </FacilityTenantItemV2>
  </FacilityTenantsList>
</FacilityTenantsV2>