List Rule/Workflow API

This API lets you fetch a catalog of all rules or workflows in your Nected workspace. It’s useful when you need to display or manage multiple entities at once. For example, building an admin dashboard, syncing entity metadata into another system, or checking what’s published vs. in draft.

Authentication

All requests require your Nected API key:

Nected-API-Key: <YOUR_API_KEY>

Endpoint

GET https://api.nected.ai/dev/{entityType}

Path Parameters

Name	Type	Required	Description
entityType	string	Yes	rule or workflow

Headers

Header	Value	Required
Nected-API-Key	Your API key string	Yes

Example (cURL)

curl --location "https://api.nected.ai/dev/rule" \
  --header "Nected-API-Key: <YOUR_API_KEY>"

Example (JavaScript / fetch)

const res = await fetch("https://api.nected.ai/dev/rule", {
  headers: { "Nected-API-Key": "<YOUR_API_KEY>" }
});
const data = await res.json();

Sample Response

{
  "data": {
    "Pagination": {
      "perPage": 10,
      "totalPage": 4,
      "currentPage": 1,
      "totalRecord": 34
    },
    "entities": [
      {
        "entityId": "11111111-aaaa-bbbb-cccc-222222222222",
        "name": "OrderValidationRules",
        "description": "Rules for validating customer orders",
        "type": "decisionTable",
        "status": "draft",
        "version": "v1",
        "endpoints": "https://nected.ai/nected/rule/11111111-aaaa-bbbb-cccc-222222222222"
      }
    ]
  },
  "code": "success",
  "message": "Success."
}

Field Reference

data.Pagination

• perPage (number): Items per page returned.

• totalPage (number): Total pages.

• currentPage (number): Current page index (1-based).

• totalRecord (number): Total entities available.

data.entities[]

• entityId (string): Unique ID.

• name (string): Entity name.

• description (string): Short description.

• type (string): For rules, e.g., decisionTable; for workflows, workflow.

• status (string): draft | published.

• version (string): Version label.

• endpoints (string): Console URL for the entity.

Errors

HTTP	Code	Meaning	Action
401	UNAUTHORIZED	Missing/invalid API key	Check Nected-API-Key.
404	NOT_FOUND	Unknown entityType	Use rule or workflow.
429	TOO_MANY_REQUESTS	Rate limit exceeded	Backoff + retry with jitter.
500	INTERNAL_SERVER_ERROR	Unexpected error	Retry; contact support if persistent.