---
title: "Workflow Edges"
description: "REST endpoints for workflow edges. Bearer-auth required."
section: "API"
group: "REST"
order: 82
---

## GET /api/workflow-edges

List workflow edges.

**Query parameters**

- `limit` (optional): Page size (1–100, default 100).
- `after` (optional): Keyset cursor — return the page after this row (next page).
- `before` (optional): Keyset cursor — return the page before this row (prev page).
- `ids` (optional): Comma-separated list of IDs. Narrows results to these IDs within the caller's accessible scope (does not bypass access checks).
- `filter` (optional): Nested filter expression (`<Entity>Filter`): AND/OR/NOT + per-field comparison operators + relation traversal. JSON-encoded on the query string.
- `orderBy` (optional): Multi-key sort (`<Entity>OrderBy[]`): array of `{ field: direction }` applied in order. Directions: asc/desc plus the four explicit nulls variants. JSON-encoded on the query string.
- `workflow_id` (required): Workflow whose edges to list.
- `source_node_id` (optional): Shorthand: filter where `sourceNodeId` equals this value.
- `target_node_id` (optional): Shorthand: filter where `targetNodeId` equals this value.

**Response**

```json
{
  "data": [
    {
      "id": "<...>",
      "workflowId": "<...>",
      "sourceNodeId": "<...>",
      "targetNodeId": "<...>",
      "handle": "<...>",
      "priority": "<...>",
      "label": "<...>",
      "createdAt": "<...>"
    }
  ],
  "pageInfo": {
    "total": "number",
    "hasNextPage": "boolean",
    "hasPreviousPage": "boolean",
    "startCursor": "string",
    "endCursor": "string"
  }
}
```

## POST /api/workflow-edges

Add a workflow edge

**Request body**

```json
{
  "workflowId": "string",
  "sourceNodeId?": "string",
  "targetNodeId?": "string",
  "handle?": "string",
  "priority?": "number",
  "label?": "string"
}
```

**Response**

```json
{
  "id": "string",
  "workflowId": "string",
  "sourceNodeId": "string",
  "targetNodeId": "string",
  "handle": "string",
  "priority": "number",
  "label": "string",
  "createdAt": "string"
}
```

## GET /api/workflow-edges/{id}

Get a workflow edge by ID.

**Path parameters**

- `id` (required): Edge to retrieve.

**Response**

```json
{
  "id": "string",
  "workflowId": "string",
  "sourceNodeId": "string",
  "targetNodeId": "string",
  "handle": "string",
  "priority": "number",
  "label": "string",
  "createdAt": "string"
}
```

## PATCH /api/workflow-edges/{id}

Update a workflow edge

**Path parameters**

- `id` (required): The workflow edge's prefixed ID.

**Request body**

```json
{
  "sourceNodeId?": "string",
  "targetNodeId?": "string",
  "handle?": "string",
  "priority?": "number",
  "label?": "string"
}
```

**Response**

```json
{
  "id": "string",
  "workflowId": "string",
  "sourceNodeId": "string",
  "targetNodeId": "string",
  "handle": "string",
  "priority": "number",
  "label": "string",
  "createdAt": "string"
}
```

## DELETE /api/workflow-edges/{id}

Delete a workflow edge.

**Path parameters**

- `id` (required): Edge to delete.

**Response**

```json
{
  "success": "boolean"
}
```