---
title: "Get Edge Rule Chains (getEdgeRuleChains)"
method: GET
path: "/api/edge/{edgeId}/ruleChains"
tags: ["rule-chain-controller"]
---

# Get Edge Rule Chains (getEdgeRuleChains)

`GET /api/edge/{edgeId}/ruleChains`

Returns a page of Rule Chains assigned to the specified edge. The rule chain object is lightweight and contains general information about the rule chain. List of rule nodes and their connection is stored in a separate 'metadata' object.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.

## Path parameters

- `edgeId` string, required

## Query parameters

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

## Response `200`

OK

- PageDataRuleChain
  - `data` RuleChain[] — Array of the entities
    - `id` RuleChainId
      - `id` string, uuid, required — ID of the entity, time-based UUID v1
      - `entityType` 'RULE_CHAIN', required — string
    - `createdTime` integer — Timestamp of the rule chain creation, in milliseconds
    - `tenantId` TenantId, required
      - `id` string, uuid, required — ID of the entity, time-based UUID v1
      - `entityType` 'TENANT', required — string
    - `name` string, required — Rule Chain name
    - `type` 'CORE' | 'EDGE' — Rule Chain type. 'EDGE' rule chains are processing messages on the edge devices only.
    - `firstRuleNodeId` RuleNodeId
      - `id` string, uuid, required — ID of the entity, time-based UUID v1
      - `entityType` 'RULE_NODE', required — string
    - `root` boolean — Indicates root rule chain. The root rule chain process messages from all devices and entities by default. User may configure default rule chain per device profile.
    - `debugMode` boolean — Reserved for future usage.
    - `version` integer
    - `configuration` unknown
    - `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)