Get backlinks for a note

GET

/notes/by-id/{id}/backlinks

curl --request GET \
  --url https://api.engram.page/notes/by-id/example/backlinks \
  --header 'Authorization: Bearer <token>'

• Production

Returns every note that links to the given note UUID (the inverse of a note’s own links). Returns 400 for a malformed UUID and 404 when no such note exists in the vault.

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string

Note UUID

Responses

200

Backlinks

Media typeapplication/json

Backlinks

object

backlinks

required

Capped at 200 edges, ordered oldest-first. Not paginated yet.

Array<object>

Backlink

object

alias

string

nullable

anchor

string

nullable

source_note_id

required

string format: uuid

source_path

string

nullable

source_title

string

nullable

Example^generated

{
  "backlinks": [
    {
      "alias": "example",
      "anchor": "example",
      "source_note_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "source_path": "example",
      "source_title": "example"
    }
  ]
}

400

Invalid UUID

Media typeapplication/json

Error

object

errors

One of:

string

string

object

object

Example^generated

{
  "errors": {}
}

404

No such note

Media typeapplication/json

Error

object

errors

One of:

string

string

object

object

Example^generated

{
  "errors": {}
}