Edges

List outbound edges

Returns the edges that start at an item. An item in the trash still lists its edges. If source_filter leaves the item out, none of its edges appear here. GET /items/{id}/backrefs lists the edges that point at it.

GET
/items/{id}/edges

Authorization

bearerAuth
headerAuthorizationBearer <token>

Authenticate with an API key (marfa_k1_…) or an OAuth access token (marfa_at_…).

Path parameters

id*string

The ID of the item.

Query parameters

edge_type?string

Only return edges of these edge types, comma-separated, up to 10.

limit?integer

The maximum number of results to return. Up to 500; a larger value is read as 500.

Range1 <= value
cursor?string

The next_cursor from the previous page. Leave it out to get the first page.

Header parameters

X-Marfa-Reach?string

The reach from a copy stream, for a working copy. Marfa reads the current data and checks the reach in one snapshot, and returns 409 reach_changed if it has changed. Leave it out for an ordinary read.

Match^[0-9a-f]{64}$
Length64 <= length <= 64

Response body

About errors

Returns a page of the item's outbound edges.

application/json
  1. response

A page of edges.

data*array<>

The edges on this page.

next_cursor*|

Pass as cursor for the next page; null on the last. A page can be short, or empty, with a cursor still to follow, so a walk stops on null and never on a short page.

  • invalid_id: the ID is not a valid item ID.
  • validation_error: a query parameter is unknown or invalid, or edge_type names more than 10 edge types.
application/json
  1. response

An error response.

error*

What went wrong.

unauthorized: the request has no credential, or its credential is not valid. For a key that has expired, details.expired_at says when it expired.

application/json
  1. response

An error response.

error*

What went wrong.

  • type_not_permitted: your credential reaches no type.
application/json
  1. response

An error response.

error*

What went wrong.

  • item_not_found: no item has this ID, or its type is one you can't read.
application/json
  1. response

An error response.

error*

What went wrong.

reach_changed: the reach in X-Marfa-Reach has changed. Rebuild the working copy.

application/json
  1. response

An error response.

error*

What went wrong.

contract_mismatch: X-Marfa-Contract names another contract version than this instance speaks, or is not a whole number. Nothing was done.

application/json
  1. response

An error response.

error*

What went wrong.

rate_limited: you sent too many requests. Wait for the number of seconds in Retry-After, then try again.

application/json
  1. response

An error response.

error*

What went wrong.

internal_error: Marfa failed in a way it didn't expect, and the request may not have completed. Read what you changed before you repeat a write.

application/json
  1. response

An error response.

error*

What went wrong.

write_contention: the database was busy, and Marfa couldn't complete the request in time. Nothing changed. Try the request again. While a restore runs, details.reason is restore_running.

application/json
  1. response

An error response.

error*

What went wrong.

insufficient_storage: the disk that holds the instance's data has no room for the request, or the request would leave less free than the instance keeps in reserve. Nothing changed, unless details.write_outcome is unknown, which means the write may have landed: read what you changed before you repeat it. Free space on the disk, then try the request again.

application/json
  1. response

An error response.

error*

What went wrong.

curl -X GET 'http://localhost:8600/items/string/edges'
About errors
{  "data": [    {      "id": "01a1011e-1222-7633-b194-950271e759ed",      "from_id": "01a1011a-4902-76cf-a4a9-88e99c038c8d",      "to_id": "01a1011c-2f86-76b6-9594-050c109f4957",      "edge_type": "acme.deal-contact",      "version": 2,      "created_at": "2026-10-03T09:41:50.646Z",      "updated_at": "2026-10-03T09:42:50.325Z",      "properties": {}    }  ],  "next_cursor": null}