Skip to content
calternal docs

List public link contents

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

Requires a valid public link with view access. It returns 403 when the link does not allow viewing or 429 when the request limit is reached. Route: /api/v1/public/{slug}/entries. Inputs: slug, path, item, X-Public-Password. Safe reads can use bounded retries.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
slug
required
string

Query Parameters

Section titled “Query Parameters”
path
string

A path relative to the shared folder. Refused on a link with hidden names.

item
string

An entry’s item ID from /entries, in place of path.

Header Parameters

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

Responses

Section titled “Responses”

200

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

Indexed Canvas identity, including plain JSON without frontmatter (#991). Set only after this listing’s current Files grant has passed.

string | null
changed_by

Named guest who created this previous Version through a public Edit link, when there is one.

string | null
content_hash
string | null
created

Inode creation time, when the Home filesystem reports statx birth time.

string | null
has_thumbnail
required
boolean
item_id
string | null
kind
required
string
mime
string | null
modified
required
string
name
required
string
original_path

Trash listings only: the Home-relative path the item is restored to.

string | null
share_badges
required
Array<string>
size
required
integer format: int64
Examplegenerated
[
  {
    "canvas_note_id": "example",
    "changed_by": "example",
    "content_hash": "example",
    "created": "example",
    "has_thumbnail": true,
    "item_id": "example",
    "kind": "example",
    "mime": "example",
    "modified": "example",
    "name": "example",
    "original_path": "example",
    "share_badges": [
      "example"
    ],
    "size": 1
  }
]

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"
  }
}