Skip to content
calternal docs

List Notes linked from a public link

GET
/api/v1/public/{slug}/linked-notes
curl --request GET \
  --url https://example.com/api/v1/public/example/linked-notes

Requires a valid public link that allows linked Notes. It returns 403 when linked Notes are not allowed or 429 when the request limit is reached. Route: /api/v1/public/{slug}/linked-notes. Inputs: slug, X-Public-Password. Safe reads can use bounded retries.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
slug
required
string

Header Parameters

Section titled “Header Parameters”
X-Public-Password
string

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
Array<object>

Public-link list projection; detail uses the Notes body-bearing DTO. A distinct schema name prevents a same-fragment collision (#833, DESIGN §41).

object
id
required
string
title
required
string
Examplegenerated
[
  {
    "id": "example",
    "title": "example"
  }
]

403

Section titled “403”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

429

Section titled “429”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}