Skip to content

List documents

GET
/api/documents

Returns a paginated list of the authenticated user’s documents. Content is omitted from list responses for performance — use the get endpoint for full content. Requires authentication.

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
limit
required
integer
default: 20 >= 1 <= 100

Number of items to return (1-100)

offset
required
integer
0 <= 9007199254740991

Number of items to skip

Responses

Section titled “ Responses ”

200

Section titled “200 ”

200

object
items
required
Array<object>

Document metadata without content (used in list views)

object
id
required

Unique document ID

string
slug
required

URL-friendly identifier

string
title
required
Any of:
string
storageKey
required

R2 object storage key

string
urlType
required

URL scheme: nanoid (free), user_scoped (/@username/slug), subdomain

string
Allowed values: nanoid user_scoped subdomain
userId
required

Owner user ID

string
status
required

Current status of the document

string
Allowed values: active expired deleted
isPublic
required

Whether the document is publicly accessible

boolean
expiresAt
required
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
viewCount
required

Number of times the document was viewed

number
createdAt
required

Creation timestamp

string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
updatedAt
required

Last update timestamp

string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
total
required
number
limit
required
number
offset
required
number

401

Section titled “401 ”

Standard error response

Standard error response

object
error
required

Error code or short description

string
message

Human-readable error details

string