v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

MSP

Get all MSP tenants information.

This API provides the list of tenants for an MSP. Tenants list includes details like tenant name, tenant CID, sites count, devices count with health status, alerts count, etc. The query parameters allow you to narrow down the results that meet specific criteria, ensuring you receive only the relevant data.

get/network-msp/v1/list-tenants

Query parameters

filterstring const

OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.

Field	Operators
siteId	eq and in
siteName	eq and in
serialNumber	eq and in
deviceName	eq and in
deviceType	eq and in
upgradeStatus	eq and in
firmwareClassification	eq and in
firmwareVersion	eq and in

The operators are implemented as follows:

eq: Only values exactly matching the given value are returned.
in: Only values present in the given list are returned.

sortstring const

Example:totalVisitorCount ASC

Sorting can be supported on the following fields: tenantName, totalSites, deviceHealthStatus, degradedSites, alerts, deviceOwnership and createdTime.

For alerts, sorting will be done in order of critical, major and minor counts. For example if input is alerts DESC, then the tenant row with the highest critical alerts count will appear at the top.

For deviceHealthStatus sorting will be done in order of poor, fair and good counts. For example if input is deviceHealthStatus DESC, then the tenant row with the highest poor health count will appear at the top.

limitinteger required

Example:20

Denotes the maximum number of tenants returned in the response. Maximum value is 100.

nextstring required

Specifies the pagination cursor for the next page of resources.

Example:1

Specifies the pagination cursor for the next page of resources. The minimum value is 1.

Response

List of tenants for an MSP. It includes details like tenant name, tenant CID, sites count, devices count with health status, alerts count, etc.

countinteger

The number of objects returned in the current response.

totalinteger

The total number of objects contained in the database.

nextstring const

Specifies the pagination cursor for the next page of resources.

Example response

{
  "count": 10,
  "total": 100,
  "next": "2",
  "items": [
    {
      "tenantName": "Tenant A",
      "tenantId": "fa451230e38a11ef8a28061d9656",
      "totalSites": 12,
      "degradedSites": 1,
      "deviceOwnership": "MSP",
      "deviceHealthStatus": {
        "total": 150,
        "good": 130,
        "fair": 15,
        "poor": 5
      },
      "alerts": {
        "total": 58,
        "critical": 8,
        "major": 10,
        "minor": 40
      },
      "lastUpdatedTime": 1732320000,
      "createdTime": 1633036806
    }
  ]
}