Skip to content

List Note links

GET
/api/v1/notes/{id}/links
curl --request GET \
--url https://example.com/api/v1/notes/example/links \
--header 'Authorization: Bearer <token>'

List outgoing links for an accessible Note by its stable identity. Shared reads retain the current access checks. Route: /api/v1/notes/{id}/links. Inputs: id. Safe reads can use bounded retries.

id
required
string
Media typeapplication/json
Array<object>

One indexed Markdown reference with its current Home item identity. One indexed Markdown reference and its current stable target identities.

object
alias
string | null
anchor
string | null
body_line
required
integer
is_local
required
boolean
is_resolved
required
boolean
kind
required
string
line
required
integer
ordinal
required
integer
raw_target
required
string
source_text
required
string
target_id
string | null
target_item_id
string | null
target_mime
string | null
target_name
string | null
target_path
string | null
target_title
string | null
Examplegenerated
[
{
"alias": "example",
"anchor": "example",
"body_line": 1,
"is_local": true,
"is_resolved": true,
"kind": "example",
"line": 1,
"ordinal": 1,
"raw_target": "example",
"source_text": "example",
"target_id": "example",
"target_item_id": "example",
"target_mime": "example",
"target_name": "example",
"target_path": "example",
"target_title": "example"
}
]