List rules (Get all)

Get a paginated list of rules in your workspace, with optional filtering by name.

Use the API reference below to try the endpoint.

List rules

get

Get a paginated list of rules in your workspace with optional filtering by name.

The 200 body includes paginationInfo (perPage, totalPage, currentPage, totalRecord) and data: an array of summary rows (id, name, type, checksum, version, status, timestamps, staticUrl, etc.). This is not the full rule JSON—use Get rule by id for customInput, conditions, action, decisionTable, etc.

Example payload is loaded from Rule/Get/GET_ALL.json when you run ruby Rule/scripts/build_openapi.rb.

Authorizations

Nected-API-KeystringRequired

Dev API key (Nected-API-Key header)

Query parameters

pageNointegerOptional

Page number

Default: 1

pageSizeintegerOptional

Items per page

Default: 10

namestringOptional

Search / filter by name

Header parameters

Nected-BranchstringOptional

Branch name (optional)

Responses

200

OK — paginationInfo + summary data rows (see ListRulesResponse).

application/json

Success response for GET /dev/v1/rule

codestringOptional

messagestringOptional

400

Bad Request

application/json

500

Internal Server Error

application/json

get/dev/v1/rule

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

{
  "paginationInfo": {
    "perPage": 3,
    "totalPage": 13,
    "currentPage": 1,
    "totalRecord": 36
  },
  "data": [
    {
      "id": "f01bb123-2d57-469a-b36c-2b3f677c1d3a",
      "name": "SampleDTNew1",
      "description": "",
      "type": "decisionTable",
      "ruleSetPolicy": "",
      "policy": "",
      "version": "draft",
      "status": "draft",
      "staticUrl": "https://nected-59.nected.io/nected/rule/f01bb123-2d57-469a-b36c-2b3f677c1d3a",
      "createdAt": "2026-03-19T04:40:20.645Z",
      "updatedAt": "2026-03-19T04:40:20.645Z",
      "publishedAt": null,
      "testedAt": null,
      "checksum": "99d5f35d0fc2ad31de40efbbb492603f",
      "isLive": false
    },
    {
      "id": "d2beec6e-eb0f-4834-b384-434cd7c260d2",
      "name": "Transaction_Fees_Calculation-0.20-1767077790544",
      "description": "",
      "type": "decisionTable",
      "ruleSetPolicy": "",
      "policy": "first",
      "version": "draft",
      "status": "draft",
      "staticUrl": "https://nected-59.nected.io/nected/rule/d2beec6e-eb0f-4834-b384-434cd7c260d2",
      "createdAt": "2025-12-30T06:56:30.544Z",
      "updatedAt": "2026-01-07T10:35:24.014278Z",
      "publishedAt": null,
      "testedAt": null,
      "checksum": "b0597fb987e1a400f5e3bb3e07061ccc",
      "isLive": false
    },
    {
      "id": "8c432b6e-3275-4ef3-9726-76a10d3a16b3",
      "name": "Term_Insurance",
      "description": "",
      "type": "decisionTable",
      "ruleSetPolicy": "",
      "policy": "first",
      "version": "draft",
      "status": "draft",
      "staticUrl": "https://nected-59.nected.io/nected/rule/8c432b6e-3275-4ef3-9726-76a10d3a16b3",
      "createdAt": "2025-06-20T09:26:19.983Z",
      "updatedAt": "2025-12-05T10:22:08.048194Z",
      "publishedAt": null,
      "testedAt": null,
      "checksum": "6d77f5351ce1539b8b57933a1f8071db",
      "isLive": false
    }
  ],
  "code": "success",
  "message": "Success."
}