---
title: "Get Device Profiles (getDeviceProfiles)"
method: GET
path: "/api/deviceProfiles"
tags: ["device-profile-controller"]
---

# Get Device Profiles (getDeviceProfiles)

`GET /api/deviceProfiles`

Returns a page of devices profile objects owned by tenant. 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 'TENANT_ADMIN' authority.

## Query parameters

- `pageSize` integer, required
- `page` integer, required
- `textSearch` string
- `sortProperty` 'createdTime' | 'name' | 'type' | 'transportType' | 'description' | 'isDefault'
- `sortOrder` 'ASC' | 'DESC'

## Response `200`

OK

- PageDataDeviceProfile
  - `data` DeviceProfile[] — Array of the entities
    - `id` DeviceProfileId
      - `id` string, uuid, required — ID of the entity, time-based UUID v1
      - `entityType` 'DEVICE_PROFILE', required — string
    - `createdTime` integer — Timestamp of the profile creation, in milliseconds
    - `tenantId` TenantId
      - `id` string, uuid, required — ID of the entity, time-based UUID v1
      - `entityType` 'TENANT', required — string
    - `name` string — Unique Device Profile Name in scope of Tenant.
    - `description` string — Device Profile description.
    - `image` string — Either URL or Base64 data of the icon. Used in the mobile application to visualize set of device profiles in the grid view.
    - `type` 'DEFAULT' — Type of the profile. Always 'DEFAULT' for now. Reserved for future use.
    - `transportType` 'DEFAULT' | 'MQTT' | 'COAP' | 'LWM2M' | 'SNMP' — Type of the transport used to connect the device. Default transport supports HTTP, CoAP and MQTT.
    - `provisionType` 'DISABLED' | 'ALLOW_CREATE_NEW_DEVICES' | 'CHECK_PRE_PROVISIONED_DEVICES' | 'X509_CERTIFICATE_CHAIN' — Provisioning strategy.
    - `defaultRuleChainId` RuleChainId
      - `id` string, uuid, required — ID of the entity, time-based UUID v1
      - `entityType` 'RULE_CHAIN', required — string
    - `defaultDashboardId` DashboardId
      - `id` string, uuid, required — ID of the entity, time-based UUID v1
      - `entityType` 'DASHBOARD', required — string
    - `defaultQueueName` string — Rule engine queue name. If present, the specified queue will be used to store all unprocessed messages related to device, including telemetry, attribute updates, etc. Otherwise, the 'Main' queue will be used to store those messages.
    - `provisionDeviceKey` string — Unique provisioning key used by 'Device Provisioning' feature.
    - `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
    - `defaultEdgeRuleChainId` RuleChainId
      - `id` string, uuid, required — ID of the entity, time-based UUID v1
      - `entityType` 'RULE_CHAIN', required — string
    - `version` integer
    - `default` boolean — Used to mark the default profile. Default profile is used when the device profile is not specified during device creation.
    - `profileData` DeviceProfileData
      - `configuration` DefaultDeviceProfileConfiguration
        - `type` string, required
      - `transportConfiguration` union — JSON object of device profile transport configuration
        - CoapDeviceProfileTransportConfiguration
          - `type` string, required
          - `coapDeviceTypeConfiguration` union
            - DefaultCoapDeviceTypeConfiguration
              - …
            - EfentoCoapDeviceTypeConfiguration
              - …
          - `clientSettings` PowerSavingConfiguration
            - `powerMode` 'PSM' | 'DRX' | 'E_DRX'
            - `psmActivityTimer` integer
            - `edrxCycle` integer
            - `pagingTransmissionWindow` integer
        - DefaultDeviceProfileTransportConfiguration
          - `type` string, required
        - Lwm2mDeviceProfileTransportConfiguration
          - `type` string, required
          - `observeAttr` TelemetryMappingConfiguration
            - `keyName` object
            - `observe` string[]
            - `attribute` string[]
            - `telemetry` string[]
            - `attributeLwm2m` object
            - `initAttrTelAsObsStrategy` boolean
            - `observeStrategy` 'SINGLE (0): One resource equals one single observe request' | 'COMPOSITE_ALL (1): All resources in one composite observe request' | 'COMPOSITE_BY_OBJECT (2): Grouped composite observe requests by object'
          - `bootstrapServerUpdateEnable` boolean
          - `bootstrap` union[]
            - union
              - …
          - `clientLwM2mSettings` OtherConfiguration
            - `useObject19ForOtaInfo` boolean
            - `fwUpdateStrategy` integer
            - `swUpdateStrategy` integer
            - `clientOnlyObserveAfterConnect` integer
            - `powerMode` 'PSM' | 'DRX' | 'E_DRX'
            - `psmActivityTimer` integer
            - `edrxCycle` integer
            - `pagingTransmissionWindow` integer
            - `fwUpdateResource` string
            - `swUpdateResource` string
            - `defaultObjectIDVer` string
        - MqttDeviceProfileTransportConfiguration
          - `type` string, required
          - `deviceTelemetryTopic` string
          - `deviceAttributesTopic` string
          - `deviceAttributesSubscribeTopic` string
          - `transportPayloadTypeConfiguration` union
            - JsonTransportPayloadConfiguration
              - …
            - ProtoTransportPayloadConfiguration
              - …
          - `sparkplug` boolean
          - `sparkplugAttributesMetricNames` string[]
          - `sendAckOnValidationException` boolean
        - SnmpDeviceProfileTransportConfiguration
          - `type` string, required
          - `timeoutMs` integer
          - `retries` integer
          - `communicationConfigs` union[]
            - union
              - …
      - `provisionConfiguration` union — JSON object of provisioning strategy type per device profile
        - AllowCreateNewDevicesDeviceProfileProvisionConfiguration
          - `provisionDeviceSecret` string
          - `type` string, required
        - CheckPreProvisionedDevicesDeviceProfileProvisionConfiguration
          - `provisionDeviceSecret` string
          - `type` string, required
        - DisabledDeviceProfileProvisionConfiguration
          - `provisionDeviceSecret` string
          - `type` string, required
        - X509CertificateChainProvisionConfiguration
          - `provisionDeviceSecret` string
          - `type` string, required
          - `certificateRegExPattern` string
          - `allowCreateNewDevicesByX509Certificate` boolean
      - `alarms` DeviceProfileAlarm[] — JSON array of alarm rules configuration per device profile
        - `id` string — String value representing the alarm rule id
        - `alarmType` string — String value representing type of the alarm
        - `createRules` object — Complex JSON object representing create alarm rules. The unique create alarm rule can be created for each alarm severity type. There can be 5 create alarm rules configured per a single alarm type. See method implementation notes and AlarmRule model for more details
        - `clearRule` AlarmRule
          - `condition` AlarmCondition
            - `condition` AlarmConditionFilter[] — JSON array of alarm condition filters
              - …
            - `spec` union — JSON object representing alarm condition type
              - …
          - `schedule` union — JSON object representing time interval during which the rule is active
            - AnyTimeSchedule
              - …
            - CustomTimeSchedule
              - …
            - SpecificTimeSchedule
              - …
          - `alarmDetails` string — String value representing the additional details for an alarm rule
          - `dashboardId` DashboardId
            - `id` string, uuid, required — ID of the entity, time-based UUID v1
            - `entityType` 'DASHBOARD', required — string
        - `propagate` boolean — Propagation flag to specify if alarm should be propagated to parent entities of alarm originator
        - `propagateToOwner` boolean — Propagation flag to specify if alarm should be propagated to the owner (tenant or customer) of alarm originator
        - `propagateToTenant` boolean — Propagation flag to specify if alarm should be propagated to the tenant entity
        - `propagateRelationTypes` string[] — JSON array of relation types that should be used for propagation. By default, 'propagateRelationTypes' array is empty which means that the alarm will be propagated based on any relation type to parent entities. This parameter should be used only in case when 'propagate' parameter is set to true, otherwise, 'propagateRelationTypes' array will be ignored.
  - `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)