GET v2/apps/{appId}/tenants/active/search?searchFilter={searchFilter}

Retreives all tenants within the app that matches the filter.

Request Information

URI Parameters

Name	Type	Description
appId	integer	Application Id Additional Info : Required
searchFilter	string	Filter (Tenant Name) Additional Info : Required

Body Parameters

None.

Response Information

Resource Description

List of Tenants

Collection of TenantResponse

Name	Type	Description
Id	integer	Id of the Tenant
AppId	integer	Application Id this tenant belongs to
DisplayName	string	Name displayed in Application
IconUrl	string	Url to the Icon/Avatar to display in the Application
IconUrl32x32	string	Url to the Icon/Avatar to display in the Application
SplashUrl	string	Url to the Splash Image for the Tenant, displayed when it is the chosen tenant
Url	string	Url of the Site for the Tenant to load on start up
Disabled	boolean	True if the Tenant is disabled, won't be sent to the Application. Users with this Tenant Selected will revert to Master App
Hidden	boolean	Not Displayed in List, but Available for use
DisplayOrder	integer	Relative number to specify the order the Tenant is displayed in the listing
CreateDate	date	Date the Tenant was created
FooterUrl	string	Url of the Footer for the tenant
ShareContent	string	Content to be used when the 'Share' button is tapped within the app. If null or empty the share button will be hidden. Typically this is the BranchUrl
BranchUrl	string	Url for the Branch Deep link to open the app to this tenant
Description	string	Description of the tenant app
FacebookLink	string	Social Media Link : Facebook
TwitterLink	string	Social Media Link : Twitter
LinkedInLink	string	Social Media Link : Linked In
GooglePlus	string	Social Media Link : Google+
Phone	string	Phone Number
SupportEmail	string	Support Email
SupportSite	string	Support Web Url
IonicTemplateId	string	If the ionic template supports multiple design for the tenant. (Id is based on the template).
Source	string	The location of the tenant when it was created.
Category	string	Category of the tenant : Auto & Vehicles, Beauty, Book & Reference, Business, Catalogs, Comics, Communications, Dating, Education, Events, Entertainment, Finance, Food & Drink, Games, Health & Fitness, House & Home, House & Home, Kids, Libraries & Demo, Lifestyle, Magazines & Newspapers, Maps & Navigation, Medical, Music & Audio, Navigation, News & Magazines, Parenting, Personalization, Photography, Productivity, Reference, Shopping, Social, Sports, Tools, Travel & Local, Utilities

[
  {
    "id": 412,
    "appId": 1234,
    "displayName": "Bob's Plumbing",
    "iconUrl": "http://imagehosting.com/AGOEN32SDSAE392DSAJ",
    "iconUrl32x32": null,
    "splashUrl": "http://imagehosting.com/AOEUHGDEG832KGd",
    "url": "http://bobdoesplumbing.com",
    "disabled": false,
    "hidden": false,
    "displayOrder": 4,
    "createDate": "2024-12-11T14:24:17.5397526Z",
    "footerUrl": "http://app.appnotch.com/converter/footer/tenant/412",
    "shareContent": "https://a2bc.app.link/ag7GFe26dE",
    "branchUrl": "https://a2bc.app.link/ag7GFe26dE",
    "description": null,
    "facebookLink": null,
    "twitterLink": null,
    "linkedInLink": null,
    "googlePlus": null,
    "phone": null,
    "supportEmail": null,
    "supportSite": null,
    "ionicTemplateId": null,
    "source": null,
    "category": null
  },
  {
    "id": 413,
    "appId": 1234,
    "displayName": "Carol's Pipes and Things",
    "iconUrl": "http://app.appnotch.com/Converter/Websites/48/1937/d359b0d9_5aaf_408c_9ac3_79f7014da40b.png",
    "iconUrl32x32": null,
    "splashUrl": "http://qa.appnotch.com/Converter/Websites/48/1937/bb175766_f514_4f83_97bd_8bd16fab2bb3.png",
    "url": "http://pipingcarol.com",
    "disabled": false,
    "hidden": false,
    "displayOrder": 3,
    "createDate": "2024-12-11T14:24:17.5397526Z",
    "footerUrl": "http://app.appnotch.com/converter/footer/tenant/413",
    "shareContent": "https://a2bc.app.link/SrW2ofea1g",
    "branchUrl": "https://a2bc.app.link/SrW2ofea1g",
    "description": null,
    "facebookLink": null,
    "twitterLink": null,
    "linkedInLink": null,
    "googlePlus": null,
    "phone": null,
    "supportEmail": null,
    "supportSite": null,
    "ionicTemplateId": null,
    "source": null,
    "category": null
  },
  {
    "id": 414,
    "appId": 1234,
    "displayName": "Mr Fix-it",
    "iconUrl": "(Blank if Not Set)",
    "iconUrl32x32": null,
    "splashUrl": "(Blank if Not Set)",
    "url": "http://mrfixit.com",
    "disabled": false,
    "hidden": false,
    "displayOrder": 2,
    "createDate": "2024-12-11T14:24:17.5397526Z",
    "footerUrl": "http://app.appnotch.com/converter/footer/tenant/414",
    "shareContent": "https://a2bc.app.link/agY26dE0pa",
    "branchUrl": "https://a2bc.app.link/agY26dE0pa",
    "description": null,
    "facebookLink": null,
    "twitterLink": null,
    "linkedInLink": null,
    "googlePlus": null,
    "phone": null,
    "supportEmail": null,
    "supportSite": null,
    "ionicTemplateId": null,
    "source": null,
    "category": null
  }
]

<ArrayOfTenantResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AppNotch.Converter.Api.Server.Models">
  <TenantResponse>
    <AppId>1234</AppId>
    <BranchUrl>https://a2bc.app.link/ag7GFe26dE</BranchUrl>
    <Category i:nil="true" />
    <CreateDate>2024-12-11T14:24:17.5397526+00:00</CreateDate>
    <Description i:nil="true" />
    <Disabled>false</Disabled>
    <DisplayName>Bob's Plumbing</DisplayName>
    <DisplayOrder>4</DisplayOrder>
    <FacebookLink i:nil="true" />
    <FooterUrl>http://app.appnotch.com/converter/footer/tenant/412</FooterUrl>
    <GooglePlus i:nil="true" />
    <Hidden>false</Hidden>
    <IconUrl>http://imagehosting.com/AGOEN32SDSAE392DSAJ</IconUrl>
    <IconUrl32x32 i:nil="true" />
    <Id>412</Id>
    <IonicTemplateId i:nil="true" />
    <LinkedInLink i:nil="true" />
    <Phone i:nil="true" />
    <ShareContent>https://a2bc.app.link/ag7GFe26dE</ShareContent>
    <Source i:nil="true" />
    <SplashUrl>http://imagehosting.com/AOEUHGDEG832KGd</SplashUrl>
    <SupportEmail i:nil="true" />
    <SupportSite i:nil="true" />
    <TwitterLink i:nil="true" />
    <Url>http://bobdoesplumbing.com</Url>
  </TenantResponse>
  <TenantResponse>
    <AppId>1234</AppId>
    <BranchUrl>https://a2bc.app.link/SrW2ofea1g</BranchUrl>
    <Category i:nil="true" />
    <CreateDate>2024-12-11T14:24:17.5397526+00:00</CreateDate>
    <Description i:nil="true" />
    <Disabled>false</Disabled>
    <DisplayName>Carol's Pipes and Things</DisplayName>
    <DisplayOrder>3</DisplayOrder>
    <FacebookLink i:nil="true" />
    <FooterUrl>http://app.appnotch.com/converter/footer/tenant/413</FooterUrl>
    <GooglePlus i:nil="true" />
    <Hidden>false</Hidden>
    <IconUrl>http://app.appnotch.com/Converter/Websites/48/1937/d359b0d9_5aaf_408c_9ac3_79f7014da40b.png</IconUrl>
    <IconUrl32x32 i:nil="true" />
    <Id>413</Id>
    <IonicTemplateId i:nil="true" />
    <LinkedInLink i:nil="true" />
    <Phone i:nil="true" />
    <ShareContent>https://a2bc.app.link/SrW2ofea1g</ShareContent>
    <Source i:nil="true" />
    <SplashUrl>http://qa.appnotch.com/Converter/Websites/48/1937/bb175766_f514_4f83_97bd_8bd16fab2bb3.png</SplashUrl>
    <SupportEmail i:nil="true" />
    <SupportSite i:nil="true" />
    <TwitterLink i:nil="true" />
    <Url>http://pipingcarol.com</Url>
  </TenantResponse>
  <TenantResponse>
    <AppId>1234</AppId>
    <BranchUrl>https://a2bc.app.link/agY26dE0pa</BranchUrl>
    <Category i:nil="true" />
    <CreateDate>2024-12-11T14:24:17.5397526+00:00</CreateDate>
    <Description i:nil="true" />
    <Disabled>false</Disabled>
    <DisplayName>Mr Fix-it</DisplayName>
    <DisplayOrder>2</DisplayOrder>
    <FacebookLink i:nil="true" />
    <FooterUrl>http://app.appnotch.com/converter/footer/tenant/414</FooterUrl>
    <GooglePlus i:nil="true" />
    <Hidden>false</Hidden>
    <IconUrl>(Blank if Not Set)</IconUrl>
    <IconUrl32x32 i:nil="true" />
    <Id>414</Id>
    <IonicTemplateId i:nil="true" />
    <LinkedInLink i:nil="true" />
    <Phone i:nil="true" />
    <ShareContent>https://a2bc.app.link/agY26dE0pa</ShareContent>
    <Source i:nil="true" />
    <SplashUrl>(Blank if Not Set)</SplashUrl>
    <SupportEmail i:nil="true" />
    <SupportSite i:nil="true" />
    <TwitterLink i:nil="true" />
    <Url>http://mrfixit.com</Url>
  </TenantResponse>
</ArrayOfTenantResponse>