Skip to main content
GET
/
api
/
cantonese
/
vocab
Vocab List
curl --request GET \
  --url https://api.example.com/api/cantonese/vocab
{
  "items": [
    {
      "progress": {
        "word_id": "<string>",
        "character_attempts": 0,
        "character_correct": 0,
        "ease_factor": 2.5,
        "interval_days": 0,
        "last_reviewed_at": "<string>",
        "listening_attempts": 0,
        "listening_correct": 0,
        "meaning_attempts": 0,
        "meaning_correct": 0,
        "next_review_at": "<string>",
        "pinyin_attempts": 0,
        "pinyin_correct": 0,
        "repetitions": 0,
        "status": "new"
      },
      "word": {
        "frequency_rank": 2,
        "hsk_level": 3,
        "id": "<string>",
        "lesson_group": "<string>",
        "meaning_en": "<string>",
        "part_of_speech": "<string>",
        "pinyin": "<string>",
        "pinyin_numbered": "<string>",
        "radical": "<string>",
        "simplified": "<string>",
        "stroke_count": 2,
        "traditional": "<string>",
        "examples": [
          {
            "cantonese": "<string>",
            "context": "everyday",
            "english": "<string>",
            "pinyin": "<string>"
          }
        ],
        "tags": [
          "<string>"
        ]
      }
    }
  ],
  "page": 1,
  "pages": 1,
  "total": 0
}

Query Parameters

​
hsk_level
integer | null
​
status
string | null
​
lesson_id
string | null
​
search
string | null
​
page
integer
default:1
​
limit
integer
default:20

Response

Successful Response

Paginated vocabulary list.

​
items
CantoneseVocabWithProgress · object[]
​
page
integer
default:1
Required range: x >= 1
​
pages
integer
default:1
Required range: x >= 1
​
total
integer
default:0
Required range: x >= 0