GET api/Tenant/{showActiveOnly}

Request Information

URI Parameters

Name	Description	Type	Additional information
showActiveOnly		boolean	Default value is True

Body Parameters

None.

Response Information

Resource Description

Collection of Tenant

Name	Type	Additional information
Id	integer	None.
AccessKey	string	None.
WebClientUrl	string	None.
ConnectionString	string	None.
ServiceEndPoint	string	None.
OfficeUsersCount	integer	None.
RemoteUsersCount	integer	None.
RateforOfficeUser	decimal number	None.
RateforRemoteUser	decimal number	None.
DepositAmount	decimal number	None.
BillingCycle	string	None.
BillingStartDate	date	None.
ExpiryDate	date	None.
Status	string	None.
Prospect	Prospect	None.
ConversionDate	date	None.
ApplicationName	string	None.
AccountId	integer	None.
CompanyId	string	None.
CreatedBy	string	None.
CreatedOn	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "AccessKey": "sample string 2",
    "WebClientUrl": "sample string 3",
    "ConnectionString": "sample string 4",
    "ServiceEndPoint": "sample string 5",
    "OfficeUsersCount": 6,
    "RemoteUsersCount": 7,
    "RateforOfficeUser": 8.0,
    "RateforRemoteUser": 9.0,
    "DepositAmount": 10.0,
    "BillingCycle": "sample string 11",
    "BillingStartDate": "2025-12-16T20:27:23.6194835+00:00",
    "ExpiryDate": "2025-12-16T20:27:23.6194835+00:00",
    "Status": "sample string 12",
    "Prospect": {
      "Id": 1,
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "JobTitle": "sample string 4",
      "CompanyName": "sample string 5",
      "Email": "sample string 6",
      "PhoneNumber": "sample string 7",
      "Country": "sample string 8",
      "State": "sample string 9",
      "BusinessType": "sample string 10",
      "OfficeUsersCount": 11,
      "RemoteUsersCount": 12,
      "Source": "sample string 13",
      "ExtensionCount": 14,
      "TrialExpiryDate": "2025-12-16T20:27:23.6194835+00:00",
      "IsActive": true,
      "AccountId": 1,
      "Comments": "sample string 16",
      "CompanyId": "sample string 18",
      "CreatedBy": "sample string 19",
      "CreatedOn": "2025-12-16T20:27:23.6194835+00:00"
    },
    "ConversionDate": "2025-12-16T20:27:23.6194835+00:00",
    "ApplicationName": "sample string 14",
    "AccountId": 15,
    "CompanyId": "sample string 16",
    "CreatedBy": "sample string 17",
    "CreatedOn": "2025-12-16T20:27:23.6194835+00:00"
  },
  {
    "Id": 1,
    "AccessKey": "sample string 2",
    "WebClientUrl": "sample string 3",
    "ConnectionString": "sample string 4",
    "ServiceEndPoint": "sample string 5",
    "OfficeUsersCount": 6,
    "RemoteUsersCount": 7,
    "RateforOfficeUser": 8.0,
    "RateforRemoteUser": 9.0,
    "DepositAmount": 10.0,
    "BillingCycle": "sample string 11",
    "BillingStartDate": "2025-12-16T20:27:23.6194835+00:00",
    "ExpiryDate": "2025-12-16T20:27:23.6194835+00:00",
    "Status": "sample string 12",
    "Prospect": {
      "Id": 1,
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "JobTitle": "sample string 4",
      "CompanyName": "sample string 5",
      "Email": "sample string 6",
      "PhoneNumber": "sample string 7",
      "Country": "sample string 8",
      "State": "sample string 9",
      "BusinessType": "sample string 10",
      "OfficeUsersCount": 11,
      "RemoteUsersCount": 12,
      "Source": "sample string 13",
      "ExtensionCount": 14,
      "TrialExpiryDate": "2025-12-16T20:27:23.6194835+00:00",
      "IsActive": true,
      "AccountId": 1,
      "Comments": "sample string 16",
      "CompanyId": "sample string 18",
      "CreatedBy": "sample string 19",
      "CreatedOn": "2025-12-16T20:27:23.6194835+00:00"
    },
    "ConversionDate": "2025-12-16T20:27:23.6194835+00:00",
    "ApplicationName": "sample string 14",
    "AccountId": 15,
    "CompanyId": "sample string 16",
    "CreatedBy": "sample string 17",
    "CreatedOn": "2025-12-16T20:27:23.6194835+00:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfTenant xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.TenantConfig">
  <Tenant>
    <AccountId xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">15</AccountId>
    <CompanyId xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">sample string 16</CompanyId>
    <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">sample string 17</CreatedBy>
    <CreatedOn xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">2025-12-16T20:27:23.6194835+00:00</CreatedOn>
    <AccessKey>sample string 2</AccessKey>
    <ApplicationName>sample string 14</ApplicationName>
    <BillingCycle>sample string 11</BillingCycle>
    <BillingStartDate>2025-12-16T20:27:23.6194835+00:00</BillingStartDate>
    <ConnectionString>sample string 4</ConnectionString>
    <ConversionDate>2025-12-16T20:27:23.6194835+00:00</ConversionDate>
    <DepositAmount>10</DepositAmount>
    <ExpiryDate>2025-12-16T20:27:23.6194835+00:00</ExpiryDate>
    <Id>1</Id>
    <OfficeUsersCount>6</OfficeUsersCount>
    <Prospect>
      <AccountId xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">17</AccountId>
      <CompanyId xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">sample string 18</CompanyId>
      <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">sample string 19</CreatedBy>
      <CreatedOn xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">2025-12-16T20:27:23.6194835+00:00</CreatedOn>
      <AccountId>1</AccountId>
      <BusinessType>sample string 10</BusinessType>
      <Comments>sample string 16</Comments>
      <CompanyName>sample string 5</CompanyName>
      <Country>sample string 8</Country>
      <Email>sample string 6</Email>
      <ExtensionCount>14</ExtensionCount>
      <FirstName>sample string 2</FirstName>
      <Id>1</Id>
      <IsActive>true</IsActive>
      <JobTitle>sample string 4</JobTitle>
      <LastName>sample string 3</LastName>
      <OfficeUsersCount>11</OfficeUsersCount>
      <PhoneNumber>sample string 7</PhoneNumber>
      <RemoteUsersCount>12</RemoteUsersCount>
      <Source>sample string 13</Source>
      <State>sample string 9</State>
      <TrialExpiryDate>2025-12-16T20:27:23.6194835+00:00</TrialExpiryDate>
    </Prospect>
    <RateforOfficeUser>8</RateforOfficeUser>
    <RateforRemoteUser>9</RateforRemoteUser>
    <RemoteUsersCount>7</RemoteUsersCount>
    <ServiceEndPoint>sample string 5</ServiceEndPoint>
    <Status>sample string 12</Status>
    <WebClientUrl>sample string 3</WebClientUrl>
  </Tenant>
  <Tenant>
    <AccountId xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">15</AccountId>
    <CompanyId xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">sample string 16</CompanyId>
    <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">sample string 17</CreatedBy>
    <CreatedOn xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">2025-12-16T20:27:23.6194835+00:00</CreatedOn>
    <AccessKey>sample string 2</AccessKey>
    <ApplicationName>sample string 14</ApplicationName>
    <BillingCycle>sample string 11</BillingCycle>
    <BillingStartDate>2025-12-16T20:27:23.6194835+00:00</BillingStartDate>
    <ConnectionString>sample string 4</ConnectionString>
    <ConversionDate>2025-12-16T20:27:23.6194835+00:00</ConversionDate>
    <DepositAmount>10</DepositAmount>
    <ExpiryDate>2025-12-16T20:27:23.6194835+00:00</ExpiryDate>
    <Id>1</Id>
    <OfficeUsersCount>6</OfficeUsersCount>
    <Prospect>
      <AccountId xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">17</AccountId>
      <CompanyId xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">sample string 18</CompanyId>
      <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">sample string 19</CreatedBy>
      <CreatedOn xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">2025-12-16T20:27:23.6194835+00:00</CreatedOn>
      <AccountId>1</AccountId>
      <BusinessType>sample string 10</BusinessType>
      <Comments>sample string 16</Comments>
      <CompanyName>sample string 5</CompanyName>
      <Country>sample string 8</Country>
      <Email>sample string 6</Email>
      <ExtensionCount>14</ExtensionCount>
      <FirstName>sample string 2</FirstName>
      <Id>1</Id>
      <IsActive>true</IsActive>
      <JobTitle>sample string 4</JobTitle>
      <LastName>sample string 3</LastName>
      <OfficeUsersCount>11</OfficeUsersCount>
      <PhoneNumber>sample string 7</PhoneNumber>
      <RemoteUsersCount>12</RemoteUsersCount>
      <Source>sample string 13</Source>
      <State>sample string 9</State>
      <TrialExpiryDate>2025-12-16T20:27:23.6194835+00:00</TrialExpiryDate>
    </Prospect>
    <RateforOfficeUser>8</RateforOfficeUser>
    <RateforRemoteUser>9</RateforRemoteUser>
    <RemoteUsersCount>7</RemoteUsersCount>
    <ServiceEndPoint>sample string 5</ServiceEndPoint>
    <Status>sample string 12</Status>
    <WebClientUrl>sample string 3</WebClientUrl>
  </Tenant>
</ArrayOfTenant>