---
title: "Get Asset Profiles (getAssetProfiles)"
method: GET
path: "/api/assetProfiles"
tags: ["asset-profile-controller"]
---

# Get Asset Profiles (getAssetProfiles)

`GET /api/assetProfiles`

Returns a page of asset 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' | 'description' | 'isDefault'
- `sortOrder` 'ASC' | 'DESC'

## Response `200`

OK

- PageDataAssetProfile
  - `data` AssetProfile[] — Array of the entities
    - `id` AssetProfileId
      - `id` string, uuid, required — ID of the entity, time-based UUID v1
      - `entityType` 'ASSET_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 Asset Profile Name in scope of Tenant.
    - `description` string — Asset Profile description.
    - `image` string — Either URL or Base64 data of the icon. Used in the mobile application to visualize set of asset profiles in the grid view.
    - `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 asset, including asset updates, telemetry, attribute updates, etc. Otherwise, the 'Main' queue will be used to store those messages.
    - `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 asset profile is not specified during asset creation.
  - `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)
