---
title: "GET /tenants"
method: GET
path: "/tenants"
tags: ["TenantController"]
---

# GET /tenants

`GET /tenants`

| Permissions |
| ------- |
| 10207   |

## Response `200`

Array of Tenant model instances

- TenantWithRelations[]
  - `deleted` boolean
  - `deletedOn` string, date-time, nullable
  - `deletedBy` string, nullable
  - `createdOn` string, date-time
  - `modifiedOn` string, date-time
  - `createdBy` string
  - `modifiedBy` string
  - `id` string
  - `name` string, required — name of the tenant
  - `status` 0 | 1 | 2 | 3 | 4 | 5, required — status of a tenant, it can be - 0(active), 1(provisioning),2(deprovisioning),3(inactive)
  - `key` string, required — a short string used to identify a tenant. This is also used as the namespace and subdomain for this particular tenant
  - `spocUserId` string — user id of the admin user who acts as a spoc for this tenant.
  - `domains` string[], required
  - `leadId` string — id of the lead from which this tenant was generated. this is optional as a tenant can be created without this lead.
  - `addressId` string — id of the address of the tenant
  - `contacts` ContactWithRelations[]
    - `deleted` boolean
    - `deletedOn` string, date-time, nullable
    - `deletedBy` string, nullable
    - `createdOn` string, date-time
    - `modifiedOn` string, date-time
    - `createdBy` string
    - `modifiedBy` string
    - `id` string
    - `name` string, required — name of the contact of a tenant
    - `email` string, required — email id of the contact
    - `isPrimary` boolean, required — boolean value denoting if the contact is a primary contact for it's tenant.
    - `tenantId` string — tenant id this contact belongs to
    - `tenant` TenantWithRelations — recursive
    - `foreignKey` unknown
  - `resources` ResourceWithRelations[]
    - `deleted` boolean
    - `deletedOn` string, date-time, nullable
    - `deletedBy` string, nullable
    - `createdOn` string, date-time
    - `modifiedOn` string, date-time
    - `createdBy` string
    - `modifiedBy` string
    - `id` string
    - `externalIdentifier` string, required — identifier for the resource in the external system it was provisioned
    - `type` string, required — type of the resource like storage, compute, etc
    - `metadata` object, required — any type specific metadata of the resource like connection info, size, etc
    - `tenantId` string — id of the tenant for which this resource is provisioned
    - `tenant` TenantWithRelations — recursive
    - `foreignKey` unknown
  - `lead` LeadWithRelations — this model represents a lead that could eventually be a tenant in the system (tsType: LeadWithRelations, schemaOptions: { includeRelations: true })
    - `deleted` boolean
    - `deletedOn` string, date-time, nullable
    - `deletedBy` string, nullable
    - `createdOn` string, date-time
    - `modifiedOn` string, date-time
    - `createdBy` string
    - `modifiedBy` string
    - `id` string
    - `name` string, required — name of the lead
    - `companyName` string, required — name of the lead's company
    - `email` string, required — email of the lead
    - `isValidated` boolean, required — whether the lead`s email has been validated or not
    - `addressId` string — id of the address of the lead
    - `tenant` TenantWithRelations — recursive
    - `address` AddressWithRelations — this model represents the address of a company or lead (tsType: AddressWithRelations, schemaOptions: { includeRelations: true })
      - `deleted` boolean
      - `deletedOn` string, date-time, nullable
      - `deletedBy` string, nullable
      - `createdOn` string, date-time
      - `modifiedOn` string, date-time
      - `createdBy` string
      - `modifiedBy` string
      - `id` string
      - `address` string — address of the company
      - `city` string — city of the company
      - `state` string — state of the company
      - `zip` string — zip code of the company
      - `country` string, required — country of the company
    - `foreignKey` unknown
  - `foreignKey` unknown
  - `address` AddressWithRelations — this model represents the address of a company or lead (tsType: AddressWithRelations, schemaOptions: { includeRelations: true })
    - `deleted` boolean
    - `deletedOn` string, date-time, nullable
    - `deletedBy` string, nullable
    - `createdOn` string, date-time
    - `modifiedOn` string, date-time
    - `createdBy` string
    - `modifiedBy` string
    - `id` string
    - `address` string — address of the company
    - `city` string — city of the company
    - `state` string — state of the company
    - `zip` string — zip code of the company
    - `country` string, required — country of the company

---

[API](https://skmtc.net/sourcefuse/apis/tenant-mgmt-service.md) · [All operations](https://skmtc.net/sourcefuse/apis/tenant-mgmt-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sourcefuse/tenant-mgmt-service/versions/788b2c08f36d/schema)