For the complete documentation index, see llms.txt. This page is also available as Markdown.

List Workflows (Get All)

Get a paginated list of workflows 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, description, version, status, staticUrl, checksum, timestamps, isLive). This is not the full workflow graph — use Get workflow by id for nodes, edges, trigger, settings, etc.

List workflows

get

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

Response shape:

  • paginationInfoperPage, totalPage, currentPage, totalRecord

  • data — array of summary rows only (id, name, description, version, status, staticUrl, checksum, timestamps, isLive). Not the full graph — call Get workflow by id for nodes, edges, trigger, settings, etc.

Canonical response file: Get/GET_ALL.json

Authorizations
Nected-API-KeystringRequired

Your Nected API key. Obtain from your workspace settings.

Query parameters
pageNointegerOptional

Page number (1-based)

Default: 1
pageSizeintegerOptional

Items per page

Default: 10
namestringOptional

Filter / search by workflow name

Header parameters
Nected-BranchstringOptional

Branch name (optional)

Responses
200

OK — paginationInfo + summary data rows.

application/json

Success response for GET /dev/v1/workflow

codestringOptional
messagestringOptional
get/dev/v1/workflow
GET /dev/v1/workflow HTTP/1.1
Host: api.nected.ai
Nected-API-Key: YOUR_API_KEY
Accept: */*
{
  "paginationInfo": {
    "perPage": 10,
    "totalPage": 2,
    "currentPage": 1,
    "totalRecord": 11
  },
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Order_Discount_Workflow",
      "description": "Calculates discount for an order based on cart total and customer tier.",
      "version": "draft",
      "status": "draft",
      "staticUrl": "https://nected-59.nected.io/nected/workflow/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "createdAt": "2026-01-15T09:30:00.000Z",
      "updatedAt": "2026-05-10T14:22:11.123Z",
      "publishedAt": "2026-03-01T08:00:00.000Z",
      "testedAt": "2026-05-10T14:20:00.000Z",
      "checksum": "7f3d2a1b9c8e4f6a0d5b2c7e1a9f3d8c",
      "isLive": false
    },
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "name": "Fraud_Detection_Workflow",
      "description": "Runs fraud checks on incoming transactions using rules and API connectors.",
      "version": "draft",
      "status": "draft",
      "staticUrl": "https://nected-59.nected.io/nected/workflow/b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "createdAt": "2025-11-20T12:00:00.000Z",
      "updatedAt": "2026-04-18T10:11:05.456Z",
      "publishedAt": "2026-02-14T07:30:00.000Z",
      "testedAt": "2026-04-18T10:09:00.000Z",
      "checksum": "2a9f3d8c7b1e4a6f0d5c2b7e9a1f3d8b",
      "isLive": true
    },
    {
      "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "name": "KYC_Onboarding_Workflow",
      "description": "End-to-end KYC verification for new customer onboarding.",
      "version": "draft",
      "status": "draft",
      "staticUrl": "https://nected-59.nected.io/nected/workflow/c3d4e5f6-a7b8-9012-cdef-123456789012",
      "createdAt": "2025-08-05T06:45:00.000Z",
      "updatedAt": "2026-01-22T09:00:00.000Z",
      "publishedAt": null,
      "testedAt": null,
      "checksum": "9c8e4f6a0d5b2c7e1a9f3d8c7b1e4a6f",
      "isLive": false
    }
  ],
  "code": "success",
  "message": "Success."
}

Example response (full JSON)

Use the API reference below to try the endpoint.

Open

Last updated