---
title: "Get Tenants (getTenants)"
method: GET
path: "/api/tenants"
tags: ["tenant-controller"]
---

# Get Tenants (getTenants)

`GET /api/tenants`

Returns a page of tenants registered in the platform. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. 

Available for users with 'SYS_ADMIN' authority.

## Query parameters

- `tenantIds` string[], required
- `pageSize` integer, required
- `page` integer, required
- `textSearch` string
- `sortProperty` 'createdTime' | 'title' | 'email' | 'country' | 'state' | 'city' | 'address' | 'address2' | 'zip' | 'phone' | 'email'
- `sortOrder` 'ASC' | 'DESC'

## Response `200`

OK

- union
  - PageDataTenant
    - `data` Tenant[] — Array of the entities
      - `id` TenantId
        - `id` string, uuid, required — ID of the entity, time-based UUID v1
        - `entityType` 'TENANT', required — string
      - `createdTime` integer — Timestamp of the tenant creation, in milliseconds
      - `country` string — Country
      - `state` string — State
      - `city` string — City
      - `address` string — Address Line 1
      - `address2` string — Address Line 2
      - `zip` string — Zip code
      - `phone` string — Phone number
      - `email` string — Email
      - `title` string, required — Title of the tenant
      - `region` string — Geo region of the tenant
      - `tenantProfileId` TenantProfileId
        - `id` string, uuid, required — ID of the entity, time-based UUID v1
        - `entityType` 'TENANT_PROFILE', required — string
      - `version` integer
      - `name` string — Name of the tenant. Read-only, duplicated from title for backward compatibility
      - `additionalInfo` unknown
    - `totalPages` integer — Total number of available pages. Calculated based on the 'pageSize' request parameter and total number of entities that match search criteria
    - `totalElements` integer — Total number of elements in all available pages
    - `hasNext` boolean — 'false' value indicates the end of the result set
  - Tenant[]
    - `id` TenantId
      - `id` string, uuid, required — ID of the entity, time-based UUID v1
      - `entityType` 'TENANT', required — string
    - `createdTime` integer — Timestamp of the tenant creation, in milliseconds
    - `country` string — Country
    - `state` string — State
    - `city` string — City
    - `address` string — Address Line 1
    - `address2` string — Address Line 2
    - `zip` string — Zip code
    - `phone` string — Phone number
    - `email` string — Email
    - `title` string, required — Title of the tenant
    - `region` string — Geo region of the tenant
    - `tenantProfileId` TenantProfileId
      - `id` string, uuid, required — ID of the entity, time-based UUID v1
      - `entityType` 'TENANT_PROFILE', required — string
    - `version` integer
    - `name` string — Name of the tenant. Read-only, duplicated from title for backward compatibility
    - `additionalInfo` unknown

---

[API](https://skmtc.net/thingsboard/apis/thingsboard-rest-api.md) · [All operations](https://skmtc.net/thingsboard/apis/thingsboard-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/thingsboard/thingsboard-rest-api/revisions/40169ccdec5c/schema)