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

# Get Tenant Edge (getTenantEdge)

`GET /api/tenant/edges`

Requested edge must be owned by tenant or customer that the user belongs to. Edge name is an unique property of edge. So it can be used to identify the edge.

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'
- `edgeName` string, required

## Response `200`

OK

- union
  - Edge — A JSON value representing the edge.
    - `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
    - `additionalInfo` unknown
  - PageDataEdge
    - `data` Edge[] — 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
      - `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)