GET v2/apps/{appId}/tenants/full?tag={tag}

Retrieves full details of all Tenants for an Application, including disabled ones. Returns Not Found if App doesn't exist or is not a Multi-Tenant App

Request Information

URI Parameters

Name Type Description
appId integer

Application Id to fetch tenants for

Additional Info :

Required

tag string

Optional case sensitive value to filter results on their tag with

Body Parameters

None.

Response Information

Resource Description

Full details of Tenants

Collection of TenantFullResponse
Name Type Description
FirstName string

First name of the owner or person responsible for the tenant app

LastName string

Last Name of the owner or person responsible for the tenant app

Phone string

Phone number of the owner or person responsible for the tenant app

SupportEmail string

Email address of the owner or person responsible for the tenant app

SupportSite string

Optional support url for the tenant app, may be different than the Url

Footer FooterResponse

Footer to be displayed if chosen (separate from master app)

Home HomeResponse

Home to be displayed if chosen

Tag string

Associated data for the tenant, for instance a database id of the member its for

SocialDescription string

Social Description used when posting links to social media Maximum string length of 255 any extra will be trimmed.

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+

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

Response Formats

[
  {
    "firstName": null,
    "lastName": null,
    "phone": null,
    "supportEmail": null,
    "supportSite": null,
    "footer": null,
    "home": null,
    "tag": "My Custom Tag",
    "socialDescription": null,
    "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": "2019-02-10T19:10:11.4161154Z",
    "footerUrl": "http://app.appnotch.com/converter/footer/tenant/412",
    "shareContent": "https://a2bc.app.link/ag7GFe26dE",
    "branchUrl": "https://a2bc.app.link/ag7GFe26dE",
    "description": "Hi, My Name is Bob, I have a small plumbing company based in Chicago, We service the south Central area, but always would love to help if you do not reside there. We provide all sorts of services for Residential and Commercial Properties. Request an free estimate appointment using this app!",
    "facebookLink": null,
    "twitterLink": null,
    "linkedInLink": null,
    "googlePlus": null,
    "ionicTemplateId": null,
    "source": null,
    "category": null
  },
  {
    "firstName": null,
    "lastName": null,
    "phone": null,
    "supportEmail": null,
    "supportSite": null,
    "footer": null,
    "home": null,
    "tag": null,
    "socialDescription": null,
    "id": 413,
    "appId": 1234,
    "displayName": "Sue's Consulting",
    "iconUrl": "http://imagehosting.com/AGOEN32SDSAE392DSAJ",
    "iconUrl32x32": null,
    "splashUrl": "http://imagehosting.com/AOEUHGDEG832KGd",
    "url": "http://someurl.com",
    "disabled": false,
    "hidden": false,
    "displayOrder": 5,
    "createDate": "2019-02-12T19:10:11.4161154Z",
    "footerUrl": "http://app.appnotch.com/converter/footer/tenant/413",
    "shareContent": "https://a2bc.app.link/ag7GFe26dF",
    "branchUrl": "https://a2bc.app.link/ag7GFe26dF",
    "description": "This is Sue's awesome consulting app that lets you schedule appointments and contact us",
    "facebookLink": null,
    "twitterLink": null,
    "linkedInLink": null,
    "googlePlus": null,
    "ionicTemplateId": null,
    "source": null,
    "category": null
  }
]
<ArrayOfTenantFullResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AppNotch.Converter.Api.Server.Models">
  <TenantFullResponse>
    <AppId>1234</AppId>
    <BranchUrl>https://a2bc.app.link/ag7GFe26dE</BranchUrl>
    <Category i:nil="true" />
    <CreateDate>2019-02-10T19:10:11.4161154+00:00</CreateDate>
    <Description>Hi, My Name is Bob, I have a small plumbing company based in Chicago, We service the south Central area, but always would love to help if you do not reside there. We provide all sorts of services for Residential and Commercial Properties. Request an free estimate appointment using this app!</Description>
    <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>
    <FirstName i:nil="true" />
    <Footer i:nil="true" />
    <Home i:nil="true" />
    <LastName i:nil="true" />
    <Phone i:nil="true" />
    <SocialDescription i:nil="true" />
    <SupportEmail i:nil="true" />
    <SupportSite i:nil="true" />
    <Tag>My Custom Tag</Tag>
  </TenantFullResponse>
  <TenantFullResponse>
    <AppId>1234</AppId>
    <BranchUrl>https://a2bc.app.link/ag7GFe26dF</BranchUrl>
    <Category i:nil="true" />
    <CreateDate>2019-02-12T19:10:11.4161154+00:00</CreateDate>
    <Description>This is Sue's awesome consulting app that lets you schedule appointments and contact us</Description>
    <Disabled>false</Disabled>
    <DisplayName>Sue's Consulting</DisplayName>
    <DisplayOrder>5</DisplayOrder>
    <FacebookLink i:nil="true" />
    <FooterUrl>http://app.appnotch.com/converter/footer/tenant/413</FooterUrl>
    <GooglePlus i:nil="true" />
    <Hidden>false</Hidden>
    <IconUrl>http://imagehosting.com/AGOEN32SDSAE392DSAJ</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/ag7GFe26dF</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://someurl.com</Url>
    <FirstName i:nil="true" />
    <Footer i:nil="true" />
    <Home i:nil="true" />
    <LastName i:nil="true" />
    <Phone i:nil="true" />
    <SocialDescription i:nil="true" />
    <SupportEmail i:nil="true" />
    <SupportSite i:nil="true" />
    <Tag i:nil="true" />
  </TenantFullResponse>
</ArrayOfTenantFullResponse>