GET /api/tenants

Search for tenants.

Remarks

Use the parameter 'top' and 'skip' for paging, 'orderby' and 'directon' for ordering the result, 'text' for the text to search for (tenant name) and the boolean 'isactive' to return active or thrashed tenants. Default values are 'isactive = true' and 'top = 50'

Request

Parameter Description Additional information
options The object that constitutes the search. Define this parameter in the url.

Response

Returns a list of tenants wrapped with paging information.

Example

{
  "Data": [
    {
      "Id": 23,
      "Name": "prefix-tenantname",
      "DeploymentStatus": null,
      "Status": "Running",
      "ResourceGroup": "prefix-grp-eastus-180912",
      "HostName": "instancename.domain.com",
      "Cname": "instancename.domain.com",
      "DatabaseServer": "prefix-sql-eastus-180919",
      "DatabaseName": "prefix-instancename",
      "CreatedAt": "2021-10-12T02:20:06.4483303Z",
      "CreatedBy": null,
      "TrashedAt": null,
      "TrashedBy": null,
      "Configuration": "{\"ThemeColor\":\"#ff00ff\",\"ThemeName\":\"Social HQ\"}",
      "Version": "4.3.2",
      "LicenseKey": null,
      "License": {
        "Key": "8CZB5-UTM8U-3GG5U-G1AAP",
        "IssuedTo": "company",
        "GraceDays": 10
      },
      "Comment": "A comment",
      "Title": "instancename",
      "Url": "https://instancename.domain.com",
      "IsTrashed": false
    },
    {
      "Id": 13,
      "Name": "prefix-tenantname",
      "DeploymentStatus": null,
      "Status": "Running",
      "ResourceGroup": "prefix-grp-eastus-180912",
      "HostName": "otherinstance.domain.com",
      "Cname": "otherinstance.domain.com",
      "DatabaseServer": "prefix-sql-eastus-180919",
      "DatabaseName": "prefix-otherinstance",
      "CreatedAt": "2021-10-02T02:20:06.4483303Z",
      "CreatedBy": null,
      "TrashedAt": null,
      "TrashedBy": null,
      "Configuration": "{\"ThemeColor\":\"#ff00ff\",\"ThemeName\":\"Social HQ\"}",
      "Version": "4.3.1",
      "LicenseKey": null,
      "License": {
        "Key": "8CZB5-UTM8U-3GG5U-G1AAP",
        "IssuedTo": "company",
        "GraceDays": 10
      },
      "Comment": "Another comment",
      "Title": "instancesite",
      "Url": "https://otherinstance.domain.com",
      "IsTrashed": false
    }
  ],
  "Top": 50,
  "Skip": 0,
  "Count": 82,
  "Next": "https://get.weavy.com/api/sites/method?top=50&skip=50"
}