List documents
Documents and folders in the Flashcard Home order, by priority, with due cards.
GET https://cotlet.dev/api/v1/remnote/documents
read
Lists the documents and folders shown in the Flashcard Home, sorted by priority, with the number of cards due in each. Upcoming exams from the Exam Scheduler come first. Folders list their sub-documents when include_children is true.
Parameters
| Name | Type | Description |
|---|---|---|
| include_children boolean | boolean | Also list documents inside folders. Default: false. |
Request
curl https://cotlet.dev/api/v1/remnote/documents \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("remnote", "list_documents")const result = await cotlet.call('remnote', 'list_documents');cotlet call remnote list_documentsExample response
{
"documents": [
{
"document_id": "rem_aa01",
"name": "Anatomy",
"priority": "high",
"cards_due": 41,
"exam": "Anatomy midterm"
},
{
"document_id": "rem_aa02",
"name": "Spanish",
"priority": "medium",
"cards_due": 18,
"exam": null
}
]
}