---
title: "Get Tenant Device (getTenantDevice)"
method: GET
path: "/api/tenant/devices"
tags: ["device-controller"]
---

# Get Tenant Device (getTenantDevice)

`GET /api/tenant/devices`

Requested device must be owned by tenant that the user belongs to. Device name is an unique property of device. So it can be used to identify the device.

Available for users with 'TENANT_ADMIN' authority.

## Query parameters

- `pageSize` integer, required
- `page` integer, required
- `type` string
- `textSearch` string
- `sortProperty` 'createdTime' | 'name' | 'deviceProfileName' | 'label' | 'customerTitle'
- `sortOrder` 'ASC' | 'DESC'
- `deviceName` string, required

## Response `200`

OK

- union
  - Device
    - `id` DeviceId
      - `id` string, uuid, required — ID of the entity, time-based UUID v1
      - `entityType` 'DEVICE', required — string
    - `createdTime` integer — Timestamp of the device creation, in milliseconds
    - `tenantId` TenantId
      - `id` string, uuid, required — ID of the entity, time-based UUID v1
      - `entityType` 'TENANT', required — string
    - `customerId` CustomerId
      - `id` string, uuid, required — ID of the entity, time-based UUID v1
      - `entityType` 'CUSTOMER', required — string
    - `name` string, required — Unique Device Name in scope of Tenant
    - `type` string — Device Profile Name
    - `label` string — Label that may be used in widgets
    - `deviceProfileId` DeviceProfileId, required
      - `id` string, uuid, required — ID of the entity, time-based UUID v1
      - `entityType` 'DEVICE_PROFILE', required — string
    - `firmwareId` OtaPackageId
      - `id` string, uuid, required — ID of the entity, time-based UUID v1
      - `entityType` 'OTA_PACKAGE', required — string
    - `softwareId` OtaPackageId
      - `id` string, uuid, required — ID of the entity, time-based UUID v1
      - `entityType` 'OTA_PACKAGE', required — string
    - `version` integer
    - `additionalInfo` unknown
    - `deviceData` DeviceData
      - `configuration` DefaultDeviceConfiguration
        - `type` string, required
      - `transportConfiguration` union — Device transport configuration used to connect the device
        - CoapDeviceTransportConfiguration
          - `type` string, required
          - `powerMode` 'PSM' | 'DRX' | 'E_DRX'
          - `psmActivityTimer` integer
          - `edrxCycle` integer
          - `pagingTransmissionWindow` integer
        - DefaultDeviceTransportConfiguration
          - `type` string, required
        - Lwm2mDeviceTransportConfiguration
          - `type` string, required
          - `powerMode` 'PSM' | 'DRX' | 'E_DRX'
          - `psmActivityTimer` integer
          - `edrxCycle` integer
          - `pagingTransmissionWindow` integer
        - MqttDeviceTransportConfiguration
          - `type` string, required
        - SnmpDeviceTransportConfiguration
          - `type` string, required
          - `host` string
          - `port` integer
          - `protocolVersion` 'V1' | 'V2C' | 'V3'
          - `community` string
          - `username` string
          - `securityName` string
          - `contextName` string
          - `authenticationProtocol` 'SHA_1' | 'SHA_224' | 'SHA_256' | 'SHA_384' | 'SHA_512' | 'MD5'
          - `authenticationPassphrase` string
          - `privacyProtocol` 'DES' | 'AES_128' | 'AES_192' | 'AES_256'
          - `privacyPassphrase` string
          - `engineId` string
  - PageDataDevice
    - `data` Device[] — Array of the entities
      - `id` DeviceId
        - `id` string, uuid, required — ID of the entity, time-based UUID v1
        - `entityType` 'DEVICE', required — string
      - `createdTime` integer — Timestamp of the device creation, in milliseconds
      - `tenantId` TenantId
        - `id` string, uuid, required — ID of the entity, time-based UUID v1
        - `entityType` 'TENANT', required — string
      - `customerId` CustomerId
        - `id` string, uuid, required — ID of the entity, time-based UUID v1
        - `entityType` 'CUSTOMER', required — string
      - `name` string, required — Unique Device Name in scope of Tenant
      - `type` string — Device Profile Name
      - `label` string — Label that may be used in widgets
      - `deviceProfileId` DeviceProfileId, required
        - `id` string, uuid, required — ID of the entity, time-based UUID v1
        - `entityType` 'DEVICE_PROFILE', required — string
      - `firmwareId` OtaPackageId
        - `id` string, uuid, required — ID of the entity, time-based UUID v1
        - `entityType` 'OTA_PACKAGE', required — string
      - `softwareId` OtaPackageId
        - `id` string, uuid, required — ID of the entity, time-based UUID v1
        - `entityType` 'OTA_PACKAGE', required — string
      - `version` integer
      - `additionalInfo` unknown
      - `deviceData` DeviceData
        - `configuration` DefaultDeviceConfiguration
          - `type` string, required
        - `transportConfiguration` union — Device transport configuration used to connect the device
          - CoapDeviceTransportConfiguration
            - `type` string, required
            - `powerMode` 'PSM' | 'DRX' | 'E_DRX'
            - `psmActivityTimer` integer
            - `edrxCycle` integer
            - `pagingTransmissionWindow` integer
          - DefaultDeviceTransportConfiguration
            - `type` string, required
          - Lwm2mDeviceTransportConfiguration
            - `type` string, required
            - `powerMode` 'PSM' | 'DRX' | 'E_DRX'
            - `psmActivityTimer` integer
            - `edrxCycle` integer
            - `pagingTransmissionWindow` integer
          - MqttDeviceTransportConfiguration
            - `type` string, required
          - SnmpDeviceTransportConfiguration
            - `type` string, required
            - `host` string
            - `port` integer
            - `protocolVersion` 'V1' | 'V2C' | 'V3'
            - `community` string
            - `username` string
            - `securityName` string
            - `contextName` string
            - `authenticationProtocol` 'SHA_1' | 'SHA_224' | 'SHA_256' | 'SHA_384' | 'SHA_512' | 'MD5'
            - `authenticationPassphrase` string
            - `privacyProtocol` 'DES' | 'AES_128' | 'AES_192' | 'AES_256'
            - `privacyPassphrase` string
            - `engineId` string
    - `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

---

[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)