This endpoint returns a list of tenants on a platform.  The returned tenants will be determined by the permissions/access of the API client.


GET    /api/admin/tenant/list/{countUsers}



Request


Url Params

countUsers
bool
sets if the response should contain user counts per tenant.  Set to 'true' to return user counts.  This param is optional and can be omitted from the url.  Default is 'false'.


Authorization

The following authorization header is required.  The authorisation header should be set to a 'Bearer Token' type


Token
see How to get a bearer token


Query Params

The end point supports oData filtering.  You are able to filter the results of the request by passing in the following query parameter in the request.  


$filter
any valid oData filter e.g. substringof(tolower('beta'),tolower(Name)).  This query param is optional

this example returns only tenants whose name contains 'beta'



Response

The response will return an array of 0 to n JSON objects.  Each JSON object in the array contains the following properties:


idintthe id of the tenant
namestringthe name of the tenant
subDomainNamestringthe sub domain name for the tenant
inDemoModeboolis the tenant in demo mode
themestringthe theme that the tenant is using
userCountintthe number of users the tenant has.  This will be 0 if the countUsers url parameter is omitted or is set to false




Permissions

The API Client requires at least readonly permissions to Tenants to successfully retrieve results (See Admin User Roles for more details).  Only tenants that the API client has access to will be returned.


Examples


C# Example


var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://{platform API url}/api/admin/tenant/list/get/true?$filter=substringof(tolower('beta'),tolower(Name))");
request.Headers.Add("Authorization", "Bearer {access token}");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());


cURL Example


curl --location 'https://{platform API url}/api/admin/tenant/list/get/true?%24filter=substringof(tolower(%27beta%27)%2Ctolower(Name))' \
--header 'Authorization: Bearer {access token}'