---
title: "Get Tenant Edge Infos (getTenantEdgeInfos)"
method: GET
path: "/api/tenant/edgeInfos"
tags: ["edge-controller"]
---

# Get Tenant Edge Infos (getTenantEdgeInfos)

`GET /api/tenant/edgeInfos`

Returns a page of edges info 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. Edge Info is an extension of the default Edge object that contains information about the assigned customer name. 

Available for users with 'TENANT_ADMIN' authority.

## Query parameters

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

## Response `200`

OK

- PageDataEdgeInfo
  - `data` EdgeInfo[] — Array of the entities
    - `id` EdgeId
      - `id` string, uuid, required — ID of the entity, time-based UUID v1
      - `entityType` 'EDGE', required — string
    - `createdTime` integer — Timestamp of the edge 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
    - `rootRuleChainId` RuleChainId
      - `id` string, uuid, required — ID of the entity, time-based UUID v1
      - `entityType` 'RULE_CHAIN', required — string
    - `name` string, required — Unique Edge Name in scope of Tenant
    - `type` string, required — Edge type
    - `label` string — Label that may be used in widgets
    - `routingKey` string, required — Edge routing key ('username') to authorize on cloud
    - `secret` string, required — Edge secret ('password') to authorize on cloud
    - `version` integer
    - `customerTitle` string
    - `customerIsPublic` boolean
    - `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

---

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