Skip to content
calternal docs

List Files items

GET
/api/v1/files/entries
curl --request GET \
  --url https://example.com/api/v1/files/entries \
  --header 'Authorization: Bearer <token>'

Requires a signed-in User with the data scope and read access to the requested folder. It returns 400 for an invalid query or 403 when access is denied. Route: /api/v1/files/entries. Inputs: path, show_hidden, show_sidecars, notes_filter, sort, cursor, limit. Safe reads can use bounded retries.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
path
string
show_hidden
boolean

Include dot files in the caller’s own Home. Shared paths stay hidden.

show_sidecars
boolean

Include sidecars paired with a regular file in the same folder.

notes_filter
boolean

Show only User-visible Notes in the Notes sidebar.

sort
string

Sort by name, kind, size, or modified. Prefix the key with - for descending order.

cursor
string

Opaque continuation token for the same User, folder, sort, and visibility scope.

limit
integer

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
breadcrumbs
required
Array<string>
entries
required
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
next_cursor
string | null
total
required
integer format: int64
Examplegenerated
{
  "breadcrumbs": [
    "example"
  ],
  "entries": [
    {
      "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
    }
  ],
  "next_cursor": "example",
  "total": 1
}

400

Section titled “400”
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"
  }
}

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