Get rule by id

Retrieve a single rule by its entity ID. Optionally pass a version query parameter (e.g. a published version).

Note: If the version is blank, then you'll retrieve the Draft version of the rule.

The API returns the standard wrapper: code, message, and data.

data is the full rule object.

To inspect a specific published version, call this endpoint with the appropriate version query value; the data shape still follows the same rule-type rules above.

Use the API reference below to try the endpoint.

Get rule by id

get

Retrieve a single rule by its entity ID. Optionally request a specific version (e.g. published). data matches the create payload for that type plus id and checksum.

Authorizations

Nected-API-KeystringRequired

Dev API key (Nected-API-Key header)

Path parameters

entity-idstringRequired

The rule's entity ID

Query parameters

versionstringOptional

Specific version to fetch (e.g. published version)

Header parameters

Nected-BranchstringOptional

Branch name (optional)

Responses

200

application/json

Standard API response wrapper

codestringOptional

dataanyOptional

Response payload: rule object, array of rules (list), version rows, or execution result — shape varies by endpoint

messagestringOptional

pageNointegerOptional

pageSizeintegerOptional

totalCountintegerOptional

totalPagesintegerOptional

400

Bad Request

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

/dev/v1/rule/{entity-id}

GET /dev/v1/rule/{entity-id} HTTP/1.1
Host: api.nected.ai
Nected-API-Key: YOUR_API_KEY
Accept: */*

{
  "code": "success",
  "message": "Success.",
  "data": {
    "id": "00000000-0000-4000-8000-000000000001",
    "checksum": "b6b3327f41ad57098758ecb5bbc42c21",
    "name": "SK",
    "description": "",
    "type": "simpleRule",
    "dataSetId": "80fb4b28-a738-4805-8db0-bf85f582d696",
    "customInput": {
      "creditApplication": {
        "attribute": "",
        "config": {},
        "dataType": "list",
        "executedValue": [
          1,
          2,
          3,
          4,
          5,
          6,
          7,
          8
        ],
        "isCaseSensitive": false,
        "isNullable": false,
        "isOptional": false,
        "name": "creditApplication",
        "next": "",
        "previous": "",
        "query": null,
        "schemaId": "",
        "sourceType": ""
      }
    },
    "conditions": {
      "startNode": "rule_01",
      "nodes": {
        "rule_01": {
          "attribute": "",
          "children": [
            "rule_02",
            "rule_lswwurgx5l42kpg243i",
            "rule_lswwus1llct3jfcvlv"
          ],
          "dataType": "",
          "leftNode": null,
          "name": "",
          "nodeType": "group",
          "operator": "and",
          "parent": "",
          "query": "",
          "returnType": "",
          "rightNode": null,
          "siblingIndex": 1,
          "sourceType": "",
          "value": null
        },
        "rule_02": {
          "attribute": "",
          "children": null,
          "dataType": "numeric",
          "leftNode": [
            "rule_03"
          ],
          "name": "",
          "nodeType": "condition",
          "operator": "gt",
          "parent": "rule_01",
          "query": "",
          "returnType": "",
          "rightNode": [
            "rule_lswwukzuldj735ysb4p"
          ],
          "siblingIndex": 1,
          "sourceType": "",
          "value": null
        },
        "rule_03": {
          "attribute": "completed_login",
          "children": null,
          "dataType": "numeric",
          "leftNode": null,
          "name": "",
          "nodeType": "params",
          "operator": "",
          "parent": "rule_02",
          "query": "",
          "returnType": "",
          "rightNode": null,
          "siblingIndex": 1,
          "sourceType": "dataSet",
          "value": null
        },
        "rule_lswwukzuldj735ysb4p": {
          "attribute": "",
          "children": null,
          "dataType": "numeric",
          "leftNode": null,
          "name": "",
          "nodeType": "constant",
          "operator": "",
          "parent": "rule_02",
          "query": "",
          "returnType": "",
          "rightNode": null,
          "siblingIndex": 1,
          "sourceType": "",
          "value": 4
        },
        "rule_lswwurgx5l42kpg243i": {
          "attribute": "",
          "children": null,
          "dataType": "numeric",
          "leftNode": [
            "rule_lswwurgxrexpopu417o"
          ],
          "name": "",
          "nodeType": "condition",
          "operator": "gt",
          "parent": "rule_01",
          "query": "",
          "returnType": "",
          "rightNode": [
            "rule_lswwux5tlfi56uuaevo"
          ],
          "siblingIndex": 2,
          "sourceType": "",
          "value": null
        },
        "rule_lswwurgxrexpopu417o": {
          "attribute": "visited_pricing",
          "children": null,
          "dataType": "numeric",
          "leftNode": null,
          "name": "",
          "nodeType": "params",
          "operator": "",
          "parent": "rule_lswwurgx5l42kpg243i",
          "query": "",
          "returnType": "",
          "rightNode": null,
          "siblingIndex": 2,
          "sourceType": "dataSet",
          "value": null
        },
        "rule_lswwus1llct3jfcvlv": {
          "attribute": "",
          "children": null,
          "dataType": "numeric",
          "leftNode": [
            "rule_lswwus1lsagp6xufxgk"
          ],
          "name": "",
          "nodeType": "condition",
          "operator": "gt",
          "parent": "rule_01",
          "query": "",
          "returnType": "",
          "rightNode": [
            "rule_lswwv2c03lctzifevlq"
          ],
          "siblingIndex": 3,
          "sourceType": "",
          "value": null
        },
        "rule_lswwus1lsagp6xufxgk": {
          "attribute": "time_spent",
          "children": null,
          "dataType": "numeric",
          "leftNode": null,
          "name": "",
          "nodeType": "params",
          "operator": "",
          "parent": "rule_lswwus1llct3jfcvlv",
          "query": "",
          "returnType": "",
          "rightNode": null,
          "siblingIndex": 3,
          "sourceType": "dataSet",
          "value": null
        },
        "rule_lswwux5tlfi56uuaevo": {
          "attribute": "",
          "children": null,
          "dataType": "numeric",
          "leftNode": null,
          "name": "",
          "nodeType": "constant",
          "operator": "",
          "parent": "rule_lswwux5tlfi56uuaevo",
          "query": "",
          "returnType": "",
          "rightNode": null,
          "siblingIndex": 1,
          "sourceType": "",
          "value": 1
        },
        "rule_lswwv2c03lctzifevlq": {
          "attribute": "",
          "children": null,
          "dataType": "numeric",
          "leftNode": null,
          "name": "",
          "nodeType": "constant",
          "operator": "",
          "parent": "rule_lswwv2c03lctzifevlq",
          "query": "",
          "returnType": "",
          "rightNode": null,
          "siblingIndex": 1,
          "sourceType": "",
          "value": 60
        }
      }
    },
    "action": {
      "then": {
        "firstOutputData": "Prospect_Quality",
        "firstActionNode": "",
        "outputData": {
          "Address": {
            "attribute": "NULL",
            "dataType": "string",
            "executedValue": "Value",
            "name": "Address",
            "next": "",
            "returnType": "",
            "schemaId": "b8b7adeb-071a-4c6c-9163-7901852c1c55",
            "source": "systemVar",
            "value": null
          },
          "Prospect_Quality": {
            "attribute": "",
            "dataType": "string",
            "executedValue": "High Intent",
            "name": "Prospect_Quality",
            "next": "Address",
            "returnType": "",
            "schemaId": "",
            "source": "",
            "value": "High Intent"
          }
        },
        "actionNode": {}
      },
      "else": {
        "firstOutputData": "",
        "firstActionNode": "actionData_1",
        "outputData": {},
        "actionNode": {
          "actionData_1": {
            "config": {
              "query": ""
            },
            "connectorId": "658ced98-8adb-4d63-b14f-21c50d716e4b",
            "entity": null,
            "entityId": null,
            "input": null,
            "name": "action_1",
            "next": "",
            "pluginName": ""
          }
        }
      }
    },
    "settings": {
      "isEnabled": true,
      "event": null,
      "api": {
        "isEnabled": true,
        "isPrivate": false
      },
      "schedule": null,
      "auditIO": false,
      "startAt": null,
      "endAt": null,
      "cache": {
        "enabled": false,
        "duration": {
          "value": 0,
          "unit": ""
        },
        "cacheKeys": ""
      },
      "dateFormat": "in",
      "timezone": "Africa/Algiers"
    },
    "firstCustomInput": "_id",
    "decisionTable": {
      "firstRow": "",
      "firstProperty": "",
      "firstResult": "",
      "firstAggOutputData": "",
      "rows": null,
      "properties": null,
      "results": null
    },
    "ruleSetPolicy": "",
    "ruleSet": [
      "94b0b2b5-6c2a-407a-b847-b1e0dfd24f91",
      "8c432b6e-3275-4ef3-9726-76a10d3a16b3"
    ],
    "firstRuleChain": "94b0b2b5-6c2a-407a-b847-b1e0dfd24f91",
    "ruleChain": {
      "8c432b6e-3275-4ef3-9726-76a10d3a16b3": {
        "isEnabled": false,
        "nextRuleId": "",
        "prevRuleId": "94b0b2b5-6c2a-407a-b847-b1e0dfd24f91"
      },
      "94b0b2b5-6c2a-407a-b847-b1e0dfd24f91": {
        "isEnabled": true,
        "nextRuleId": "8c432b6e-3275-4ef3-9726-76a10d3a16b3",
        "prevRuleId": ""
      }
    },
    "policy": "",
    "dependencyMap": []
  }
}