Skip to content
Orimora Docs

List published documents in a channel

GET
/api/v1/published/{channelId}/documents
 
curl --request GET \
  --url 'https://your-orimora-instance.example.com/api/v1/published/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/documents?limit=50' \
  --header 'Authorization: Bearer <token>'

Returns published documents accessible via a publishing channel. Authentication uses a channel token (not a user API key) — create one in Settings → Publishing → Channels → Tokens.

Supports cursor-based pagination via cursor (ISO timestamp of the last seen updatedAt). Use updatedSince for incremental sync.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
channelId
required
string format: uuid

Query Parameters

Section titled “Query Parameters ”
limit
integer
default: 50 >= 1 <= 200
cursor

ISO timestamp — returns documents updated before this point (pagination)

string

ISO timestamp — returns documents updated before this point (pagination)

updatedSince

ISO 8601 — return only documents updated after this timestamp

string format: date-time

ISO 8601 — return only documents updated after this timestamp

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Paginated list of published documents

Media type application/json
object
data
required
Array<object>
object
id
required
string format: uuid
title
required
string
emoji
required
string | null
text
required

Plain-text content

string | null
collectionId
required
string | null format: uuid
publishedAt
required
string format: date-time
updatedAt
required
string format: date-time
markdownText

Markdown body — only present when requested via channel format settings

string
nextCursor

Pass as cursor in the next request to get the next page

string
Example generated
{
  "data": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "title": "example",
      "emoji": "example",
      "text": "example",
      "collectionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "publishedAt": "2026-04-15T12:00:00Z",
      "updatedAt": "2026-04-15T12:00:00Z",
      "markdownText": "example"
    }
  ],
  "nextCursor": "example"
}

401

Section titled “401 ”

Unauthorized (missing or invalid channel token)

Media type application/json
object
error
required

Human-readable error message

string
Example generated
{
  "error": "example"
}

403

Section titled “403 ”

Token does not match the requested channel

Media type application/json
object
error
required

Human-readable error message

string
Example generated
{
  "error": "example"
}