---
title: "Get Tenant Profiles (getTenantProfiles)"
method: GET
path: "/api/tenantProfiles"
tags: ["tenant-profile-controller"]
---

# Get Tenant Profiles (getTenantProfiles)

`GET /api/tenantProfiles`

Returns a page of tenant profiles 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

- `pageSize` integer, required
- `page` integer, required
- `textSearch` string
- `sortProperty` 'createdTime' | 'name' | 'description' | 'isDefault'
- `sortOrder` 'ASC' | 'DESC'
- `ids` string[], required

## Response `200`

OK

- union
  - TenantProfile[]
    - `id` TenantProfileId
      - `id` string, uuid, required — ID of the entity, time-based UUID v1
      - `entityType` 'TENANT_PROFILE', required — string
    - `createdTime` integer — Timestamp of the tenant profile creation, in milliseconds
    - `name` string — Name of the tenant profile
    - `description` string — Description of the tenant profile
    - `isolatedTbRuleEngine` boolean — If enabled, will push all messages related to this tenant and processed by the rule engine into separate queue. Useful for complex microservices deployments, to isolate processing of the data for specific tenants
    - `profileData` TenantProfileData
      - `configuration` DefaultTenantProfileConfiguration
        - `type` string, required
        - `maxDevices` integer
        - `maxAssets` integer
        - `maxCustomers` integer
        - `maxUsers` integer
        - `maxDashboards` integer
        - `maxRuleChains` integer
        - `maxEdges` integer
        - `maxResourcesInBytes` integer
        - `maxOtaPackagesInBytes` integer
        - `maxResourceSize` integer
        - `transportTenantMsgRateLimit` string
        - `transportTenantTelemetryMsgRateLimit` string
        - `transportTenantTelemetryDataPointsRateLimit` string
        - `transportDeviceMsgRateLimit` string
        - `transportDeviceTelemetryMsgRateLimit` string
        - `transportDeviceTelemetryDataPointsRateLimit` string
        - `transportGatewayMsgRateLimit` string
        - `transportGatewayTelemetryMsgRateLimit` string
        - `transportGatewayTelemetryDataPointsRateLimit` string
        - `transportGatewayDeviceMsgRateLimit` string
        - `transportGatewayDeviceTelemetryMsgRateLimit` string
        - `transportGatewayDeviceTelemetryDataPointsRateLimit` string
        - `tenantEntityExportRateLimit` string
        - `tenantEntityImportRateLimit` string
        - `tenantNotificationRequestsRateLimit` string
        - `tenantNotificationRequestsPerRuleRateLimit` string
        - `maxTransportMessages` integer
        - `maxTransportDataPoints` integer
        - `maxREExecutions` integer
        - `maxJSExecutions` integer
        - `maxTbelExecutions` integer
        - `maxDPStorageDays` integer
        - `maxRuleNodeExecutionsPerMessage` integer
        - `maxDebugModeDurationMinutes` integer
        - `maxEmails` integer
        - `smsEnabled` boolean
        - `maxSms` integer
        - `maxCreatedAlarms` integer
        - `tenantServerRestLimitsConfiguration` string
        - `customerServerRestLimitsConfiguration` string
        - `maxWsSessionsPerTenant` integer
        - `maxWsSessionsPerCustomer` integer
        - `maxWsSessionsPerRegularUser` integer
        - `maxWsSessionsPerPublicUser` integer
        - `wsMsgQueueLimitPerSession` integer
        - `maxWsSubscriptionsPerTenant` integer
        - `maxWsSubscriptionsPerCustomer` integer
        - `maxWsSubscriptionsPerRegularUser` integer
        - `maxWsSubscriptionsPerPublicUser` integer
        - `wsUpdatesPerSessionRateLimit` string
        - `cassandraReadQueryTenantCoreRateLimits` string
        - `cassandraWriteQueryTenantCoreRateLimits` string
        - `cassandraReadQueryTenantRuleEngineRateLimits` string
        - `cassandraWriteQueryTenantRuleEngineRateLimits` string
        - `edgeEventRateLimits` string
        - `edgeEventRateLimitsPerEdge` string
        - `edgeUplinkMessagesRateLimits` string
        - `edgeUplinkMessagesRateLimitsPerEdge` string
        - `defaultStorageTtlDays` integer
        - `alarmsTtlDays` integer
        - `rpcTtlDays` integer
        - `queueStatsTtlDays` integer
        - `ruleEngineExceptionsTtlDays` integer
        - `warnThreshold` number, double
        - `maxCalculatedFieldsPerEntity` integer
        - `maxArgumentsPerCF` integer
        - `minAllowedScheduledUpdateIntervalInSecForCF` integer
        - `maxRelationLevelPerCfArgument` integer
        - `maxRelatedEntitiesToReturnPerCfArgument` integer
        - `maxDataPointsPerRollingArg` integer
        - `maxStateSizeInKBytes` integer
        - `maxSingleValueArgumentSizeInKBytes` integer
        - `minAllowedDeduplicationIntervalInSecForCF` integer
        - `minAllowedAggregationIntervalInSecForCF` integer
        - `intermediateAggregationIntervalInSecForCF` integer
        - `cfReevaluationCheckInterval` integer
        - `alarmsReevaluationInterval` integer
      - `queueConfiguration` TenantProfileQueueConfiguration[] — JSON array of queue configuration per tenant profile
        - `name` string
        - `topic` string
        - `pollInterval` integer
        - `partitions` integer
        - `consumerPerPartition` boolean
        - `packProcessingTimeout` integer
        - `submitStrategy` SubmitStrategy
          - `type` 'BURST' | 'BATCH' | 'SEQUENTIAL_BY_ORIGINATOR' | 'SEQUENTIAL_BY_TENANT' | 'SEQUENTIAL'
          - `batchSize` integer
        - `processingStrategy` ProcessingStrategy
          - `type` 'SKIP_ALL_FAILURES' | 'SKIP_ALL_FAILURES_AND_TIMED_OUT' | 'RETRY_ALL' | 'RETRY_FAILED' | 'RETRY_TIMED_OUT' | 'RETRY_FAILED_AND_TIMED_OUT'
          - `retries` integer
          - `failurePercentage` number, double
          - `pauseBetweenRetries` integer
          - `maxPauseBetweenRetries` integer
        - `additionalInfo` unknown
    - `default` boolean — Default Tenant profile to be used.
  - PageDataTenantProfile
    - `data` TenantProfile[] — Array of the entities
      - `id` TenantProfileId
        - `id` string, uuid, required — ID of the entity, time-based UUID v1
        - `entityType` 'TENANT_PROFILE', required — string
      - `createdTime` integer — Timestamp of the tenant profile creation, in milliseconds
      - `name` string — Name of the tenant profile
      - `description` string — Description of the tenant profile
      - `isolatedTbRuleEngine` boolean — If enabled, will push all messages related to this tenant and processed by the rule engine into separate queue. Useful for complex microservices deployments, to isolate processing of the data for specific tenants
      - `profileData` TenantProfileData
        - `configuration` DefaultTenantProfileConfiguration
          - `type` string, required
          - `maxDevices` integer
          - `maxAssets` integer
          - `maxCustomers` integer
          - `maxUsers` integer
          - `maxDashboards` integer
          - `maxRuleChains` integer
          - `maxEdges` integer
          - `maxResourcesInBytes` integer
          - `maxOtaPackagesInBytes` integer
          - `maxResourceSize` integer
          - `transportTenantMsgRateLimit` string
          - `transportTenantTelemetryMsgRateLimit` string
          - `transportTenantTelemetryDataPointsRateLimit` string
          - `transportDeviceMsgRateLimit` string
          - `transportDeviceTelemetryMsgRateLimit` string
          - `transportDeviceTelemetryDataPointsRateLimit` string
          - `transportGatewayMsgRateLimit` string
          - `transportGatewayTelemetryMsgRateLimit` string
          - `transportGatewayTelemetryDataPointsRateLimit` string
          - `transportGatewayDeviceMsgRateLimit` string
          - `transportGatewayDeviceTelemetryMsgRateLimit` string
          - `transportGatewayDeviceTelemetryDataPointsRateLimit` string
          - `tenantEntityExportRateLimit` string
          - `tenantEntityImportRateLimit` string
          - `tenantNotificationRequestsRateLimit` string
          - `tenantNotificationRequestsPerRuleRateLimit` string
          - `maxTransportMessages` integer
          - `maxTransportDataPoints` integer
          - `maxREExecutions` integer
          - `maxJSExecutions` integer
          - `maxTbelExecutions` integer
          - `maxDPStorageDays` integer
          - `maxRuleNodeExecutionsPerMessage` integer
          - `maxDebugModeDurationMinutes` integer
          - `maxEmails` integer
          - `smsEnabled` boolean
          - `maxSms` integer
          - `maxCreatedAlarms` integer
          - `tenantServerRestLimitsConfiguration` string
          - `customerServerRestLimitsConfiguration` string
          - `maxWsSessionsPerTenant` integer
          - `maxWsSessionsPerCustomer` integer
          - `maxWsSessionsPerRegularUser` integer
          - `maxWsSessionsPerPublicUser` integer
          - `wsMsgQueueLimitPerSession` integer
          - `maxWsSubscriptionsPerTenant` integer
          - `maxWsSubscriptionsPerCustomer` integer
          - `maxWsSubscriptionsPerRegularUser` integer
          - `maxWsSubscriptionsPerPublicUser` integer
          - `wsUpdatesPerSessionRateLimit` string
          - `cassandraReadQueryTenantCoreRateLimits` string
          - `cassandraWriteQueryTenantCoreRateLimits` string
          - `cassandraReadQueryTenantRuleEngineRateLimits` string
          - `cassandraWriteQueryTenantRuleEngineRateLimits` string
          - `edgeEventRateLimits` string
          - `edgeEventRateLimitsPerEdge` string
          - `edgeUplinkMessagesRateLimits` string
          - `edgeUplinkMessagesRateLimitsPerEdge` string
          - `defaultStorageTtlDays` integer
          - `alarmsTtlDays` integer
          - `rpcTtlDays` integer
          - `queueStatsTtlDays` integer
          - `ruleEngineExceptionsTtlDays` integer
          - `warnThreshold` number, double
          - `maxCalculatedFieldsPerEntity` integer
          - `maxArgumentsPerCF` integer
          - `minAllowedScheduledUpdateIntervalInSecForCF` integer
          - `maxRelationLevelPerCfArgument` integer
          - `maxRelatedEntitiesToReturnPerCfArgument` integer
          - `maxDataPointsPerRollingArg` integer
          - `maxStateSizeInKBytes` integer
          - `maxSingleValueArgumentSizeInKBytes` integer
          - `minAllowedDeduplicationIntervalInSecForCF` integer
          - `minAllowedAggregationIntervalInSecForCF` integer
          - `intermediateAggregationIntervalInSecForCF` integer
          - `cfReevaluationCheckInterval` integer
          - `alarmsReevaluationInterval` integer
        - `queueConfiguration` TenantProfileQueueConfiguration[] — JSON array of queue configuration per tenant profile
          - `name` string
          - `topic` string
          - `pollInterval` integer
          - `partitions` integer
          - `consumerPerPartition` boolean
          - `packProcessingTimeout` integer
          - `submitStrategy` SubmitStrategy
            - `type` 'BURST' | 'BATCH' | 'SEQUENTIAL_BY_ORIGINATOR' | 'SEQUENTIAL_BY_TENANT' | 'SEQUENTIAL'
            - `batchSize` integer
          - `processingStrategy` ProcessingStrategy
            - `type` 'SKIP_ALL_FAILURES' | 'SKIP_ALL_FAILURES_AND_TIMED_OUT' | 'RETRY_ALL' | 'RETRY_FAILED' | 'RETRY_TIMED_OUT' | 'RETRY_FAILED_AND_TIMED_OUT'
            - `retries` integer
            - `failurePercentage` number, double
            - `pauseBetweenRetries` integer
            - `maxPauseBetweenRetries` integer
          - `additionalInfo` unknown
      - `default` boolean — Default Tenant profile to be used.
    - `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)