Documents
List items with filters and paging, read one, get its full text, and read a note's content, with the fields of an item.
An item is called a document in the API. These are the read operations (scope read).
List items#
GET /api/v1/documents| Parameter | Meaning |
|---|---|
source_type | One of upload, note, link, meeting, voice, photo, import, connector. |
status | queued, processing, completed or failed. |
space_id | Only items in this space. |
tag | Only items with this tag. |
owner | A user id, or me. |
q | Title contains this text. |
updated_since | Items changed on or after this instant (RFC 3339). |
limit | Page size, up to 200. |
offset | Where to start. |
curl -s -H "Authorization: Bearer $TOKEN" \
"$BRENO/documents?source_type=note&owner=me&updated_since=2026-10-01T00:00:00Z&limit=50"An invalid filter returns 400 INVALID_FILTER.
List items as cards#
GET /api/v1/documents/cardsThe same list, with a summary, word count and connections for each item, for interfaces that show cards.
Get one#
GET /api/v1/documents/{id}Returns the item and what you may do with it. A missing item, and one you cannot read, both return 404 NOT_FOUND, so a token cannot discover that something exists.
Full text#
GET /api/v1/documents/{id}/textThe full extracted text of any item you can read.
A note's content#
GET /api/v1/documents/{id}/contentThe saved content of a note, as block JSON with a plain-text fallback. Notes only; it returns 403 for items that are read-only.
The item#
| Field | Meaning |
|---|---|
id, title | Identity. |
status | queued, processing, completed or failed. |
failure_reason | Why, when status is failed. |
enrichment_warning | The item is searchable, but summary, entity or tag enrichment failed or was partial. |
source_type | How it arrived (see the filter above). |
source | Provenance for a synced item: provider, connection_name, url, author, updated_at, synced_at, syncing. |
owner | Who added it; null for legacy items and connector items with no known creator. |
visibility | workspace or private (readable by the owner only). |
sensitivity | public, internal, confidential or restricted. |
space_id | Its space; absent for items in the workspace commons. |
tags | Its tags. |
original_filename, mime_type, size_bytes | File details, for uploads. |
content_editable | True for notes and plain Markdown or text items. |
can_edit, can_delete, is_owner | What the caller may do (on single-item reads). |
created_at, updated_at | Times. |
The exact schema is in the OpenAPI document.