Skip to content
Orimora Docs

List documents

GET
/api/v1/documents

Returns a paginated list of documents. Use updatedSince for incremental sync (e.g. Obsidian plugin).

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
collectionId

Filter by collection

string format: uuid

Filter by collection

status

Filter by publish status

string
Allowed values: published draft

Filter by publish status

limit
integer
default: 25 >= 1 <= 100
offset
integer | null
0
updatedSince

ISO 8601 datetime. When set, returns only documents updated after this timestamp. Raises the default limit to 500.

string format: date-time

ISO 8601 datetime. When set, returns only documents updated after this timestamp. Raises the default limit to 500.

format

When markdown and updatedSince is set, includes a markdownText field per document

string
Allowed values: markdown

When markdown and updatedSince is set, includes a markdownText field per document

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Paginated list of documents

Any of:
object
total
required

Total number of matching records

integer
limit
required

Page size

integer
offset
required

Page offset

integer
data
required
Array<object>
object
id
required
string format: uuid
title
required

Document title

string
emoji
required

Optional emoji prefix for the document icon

string | null
text
required

Plain-text content (read-only, derived from body)

string | null
collectionId
required
string | null format: uuid
parentDocumentId
required
string | null format: uuid
teamId
required
string format: uuid
createdById
required
string | null format: uuid
lastModifiedById
required
string | null format: uuid
publishedAt
required

Null = draft

string | null format: date-time
archivedAt
required
string | null format: date-time
deletedAt
required
string | null format: date-time
revision
required
integer
sortOrder
required
number
fullWidth
required
boolean
collaborativeId
required
string | null
createdAt
required
string format: date-time
updatedAt
required
string format: date-time

401

Section titled “401 ”

Unauthorized

object
error
required

Human-readable error message

string