List words
list_wordsThe user's words, a page at a time, with filters: due, new/not_started, struggling, starred, mastered, retired, corrections, hard_spelling; a level, a topic, a date range, a text query and a sort. notebook_id all covers every notebook. The first page says how many words match (total). While more words match, a page ends with next_cursor; sent back as cursor with the same arguments, it returns the next page.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Order. Default recent (newest first). | |
| level | No | Only this CEFR level. | |
| limit | No | Words per page, 1 to 100. Default 50. | |
| query | No | Only words matching this text, in either language. | |
| topic | No | Only words filed under this topic (for an imported book, its title). | |
| cursor | No | next_cursor from the previous page of the same call; omit for the first page. | |
| filter | No | Which words. Default all. | |
| added_after | No | Only words added on or after this date, YYYY-MM-DD. | |
| notebook_id | No | A notebook id from list_notebooks, or all for every notebook. Omit for the default notebook. | |
| added_before | No | Only words added before this date, YYYY-MM-DD. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| total | No | ||
| words | Yes | ||
| nextCursor | No | ||
| notebookId | Yes | ||
| totalIsAtLeast | No |