Graph Edges

REST endpoints for graph edges. Bearer-auth required.

GET /api/graph-edges

List graph 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.
  • graph_id (optional): Optional graph narrower. Admins see every edge when omitted; non-admin callers must scope by graph.
  • edge_definition_id (optional): Filter to edges of this edge definition.
  • node_id (optional): Filter to edges incident on this node.
  • 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": "<...>",
      "graphId": "<...>",
      "edgeDefinitionId": "<...>",
      "sourceNodeId": "<...>",
      "targetNodeId": "<...>",
      "label": "<...>",
      "properties?": "<...>",
      "createdAt": "<...>"
    }
  ],
  "pageInfo": {
    "total": "number",
    "hasNextPage": "boolean",
    "hasPreviousPage": "boolean",
    "startCursor": "string",
    "endCursor": "string"
  }
}

GET /api/graph-edges/{id}

Get a graph edge by ID.

Path parameters

  • id (required): Edge to retrieve.

Response

JSON
{
  "id": "string",
  "graphId": "string",
  "edgeDefinitionId": "string",
  "sourceNodeId": "string",
  "targetNodeId": "string",
  "label": "string",
  "properties?": "any",
  "createdAt": "string"
}