---
title: "GetRequiredFieldsByRuleId"
method: GET
path: "/api/RulesEngine/GetRequiredFieldsByRuleId"
tags: ["RulesEngine"]
---

# GetRequiredFieldsByRuleId

`GET /api/RulesEngine/GetRequiredFieldsByRuleId`

## Request

- Base URL: `https://eu-ext.linnworks.net`
- URL: `https://eu-ext.linnworks.net/api/RulesEngine/GetRequiredFieldsByRuleId`
- Auth: API key in header `Authorization`

Use this call to get a list of fields and keys used by a given rule.
<b>Permissions Required: </b> GlobalPermissions.OrderBook.RulesEngineNode
<b>Rate limit: </b><span style="background-color:#0272d9;color:white;padding:4px 8px;text-align:center;border-radius:5px; font-size: small;"><b>150</b></span> / minute

## Query parameters

- `pkRuleId` integer

## Response `200`

OK

- RulesFields
  - `FieldNames` string[]
  - `FieldKeys` object
  - `IdName` string

---

[API](https://skmtc.dev/linnworks/apis/rules-engine-api.md) - [All operations](https://skmtc.dev/linnworks/apis/rules-engine-api/llms.txt) - [OpenAPI document](https://skmtc.dev/linnworks/apis/rules-engine-api/revisions/52df4ad3d247?raw)