---
title: "Get tenants list"
method: GET
path: "/msp/v3/tenants"
tags: ["Tenants"]
---

# Get tenants list

`GET /msp/v3/tenants`

Returns list of tenants.

## Query parameters

- `pageToken` string
- `customerIds` string
- `pageSize` string
- `includeFeatures` boolean

## Headers

- `Authorization` string, required

## Response `200`

Ok

- GetTenantsV3Response
  - `tenants` GetTenantV3Response[] — The list of tenants and their information.
    - `id` string — The unique ID of the tenant. Example - 'e293b4c7-a984-4813-8fba-526d5b0edc80'
    - `customerID` string — The unique ID of the MSP customer. Example - '8ccbc1c-0ca0-4077-ad94-a74479c299b8'
    - `productID` integer — The ID of the product tenant. - For Enterprise Workloads, it is '1'. - For SaaS Apps and Endpoints, it is '2'.
    - `licenseExpiryDate` string, date-time — The date on which the license of tenant will expire. Example - '2022-10-25T00:00:00Z'
    - `quota` number, double — The quota limit for the tenant. It is a soft limit affecting only quota alerts and reporting. Example - 1.5
    - `quotaEndDate` string, date-time — The quota end date for the tenant. Example - '2022-10-25T00:00:00Z'
    - `quotaStartDate` string, date-time — The quota start date for the tenant. Example - '2022-10-25T00:00:00Z'
    - `servicePlanID` integer — The unique ID of the service plan associated with the tenant. Example - 1
    - `edition` string — The product license edition associated with the tenant. The edition can have one of the following values - - business - enterprise - elite
    - `storageRegions` StorageRegions[] — The 'name' of storage region and its associated storage provider where the data is stored for the tenant. - Storage Provider values: 1 (AWS), 2 (Azure)
      - `name` string — - Name of the storage region. Example - 'us-east-1'
      - `storageProvider` integer — - Storage Provider (AWS/Azure) that is associated with the storage region. Storage Provider values: 1 (AWS), 2 (Azure)
    - `features` TenantFeaturesV3[] — The list of features enabled for the tenant.
      - `name` string — - Name of the feature. Example - 'M365' - For valid products and their values, see - https://developer.druva.com/docs/msp-product-and-attribute-values
      - `attrs` FeatureAttributeForV3[] — - Attributes to be enabled for tenant. - Attrs can be empty. Example - [] - For valid products and their values, see - https://developer.druva.com/docs/msp-product-and-attribute-values
        - `name` string — Specify the name of the attribute. Example - 'userCount', 'preservedUserCount'
        - `value` object — Specify the value of the attribute. Example - 100
    - `tenantType` integer — Specify the tenant type for the product. - Specify '1' if it is a Sandbox. - Specify '2' if it is Evaluation. This is a trial plan with a validity of 30 days. If you select this tenant type, the product license will be active until 30 days. After 30 days, you must change the tenant type to Commercial. - Specify '3' if it is Commercial. For this tenant type, a Enterprise Workloads license is valid for eight years, while a SaaS Apps and Endpoints license is valid for three years.
    - `status` integer — - The current status of the tenant. - 0 Creation Pending - Creation is pending of the tenant. - 1 Ready - The tenant is created and associated with the customer. - 2 Suspended - The tenant is suspended. - 3 Soft deleted - The deletion of the tenant is initiated. - 4 Being migrated - Migration of the tenant is in progress. - 5 Updating - Tenant updation in under progress.
    - `createdOn` string, date-time — The date and time on which the tenant was created. Example - '2022-10-25T00:00:00Z'
    - `activeSince` string, date-time — The date and time since the tenant is active for the customer. Example - '2022-10-25T00:00:00Z'
    - `deleteDate` string, date-time — The date and time on which the tenant assigned to the customer will be deleted. If the tenant is not marked for deletion, no value is displayed. Example - '2022-10-25T00:00:00Z'
  - `nextPageToken` string — The token to access the next page of results. This is empty if there are no more results. Example - 'eyJwYWdlU2l6ZSI6IDEwMH0='

## Other responses

- `400` — Bad Request
- `401` — The request did not include a valid Access Token. Kindly provide a valid Access Token to process the request.
- `404` — The requested resource was not found.
- `500` — The request was not processed due to an internal error. Kindly try again later. If the error persists, contact Druva Support.

---

[API](https://skmtc.net/druva/apis/authentication.md) · [All operations](https://skmtc.net/druva/apis/authentication/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/druva/authentication/revisions/2af2bf148b25/schema)