API Documentation
Account
Card management
Goals
Statistics
Quests
curl --request POST \
--url http://dolphinflashcards.com/api/get-today-cards \
--header 'Content-Type: application/json' \
--data '
{
"jwtToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NiIsImtpZCI6ImEzMmZkZDRiMTQ2Njc3NzE5YWIyMzcyODYxYmRlZDg5In0.eyJpc3MiOiJodHRwOi8vZG9scGhpbmZsYXNoY2FyZHMuY29tIiwiYXVkIjoiYXBpIiwic3ViIjoidU5RR2lIencxdk9EaExybTVDRWtaQ1ZoTU93MSIsImFjY2Vzc190b2tlbiI6IjRiZTA2NDNmLTFkOTgtNTczYi05N2NkLWNhOThhNjUzNDdkZCIsImFjY2Vzc190b2tlbl9yYXciOiJ0ZXN0IiwiaWF0IjoxNzI2Nzc0MTYzfQ.F-fxFitPQF-gGHyhGPGxE_zj_b8XJybqe4J_iYG66BC4Dqm4LTb8RpcDLyYUhRCcpphihpWGbdp"
}
'{
"Folder": {
"Flashcard": {
"cards": {
"cardID": {
"last_review": "15/07/2024",
"review_status": "0.0"
}
},
"flashcardID": "6796878844471389968582206160161573797336081811111331165973477783999823937257",
"flashcardName": "firstFlashCard"
},
"secondFlashcard": {
"cards": {
"cardID": {
"last_review": "15/07/2024",
"review_status": "0.0"
}
},
"flashcardID": "<string>",
"flashcardName": "secondFlashCard"
}
},
"top-level-parent-name": {
"parent-name-2": {
"parent-name-3": {
"Flashcard": {
"cards": {
"cardID": {
"last_review": "<string>",
"review_status": "<string>"
}
},
"flashcardID": "<string>",
"flashcardName": "<string>"
}
}
}
}
}Get Today Cards
Get all the flashcards to be learned today for a user. If a card’s review status is 0.0, it is not started; if it is 0.x, it is actively studying; if it is >= 1.x, it is learned.
curl --request POST \
--url http://dolphinflashcards.com/api/get-today-cards \
--header 'Content-Type: application/json' \
--data '
{
"jwtToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NiIsImtpZCI6ImEzMmZkZDRiMTQ2Njc3NzE5YWIyMzcyODYxYmRlZDg5In0.eyJpc3MiOiJodHRwOi8vZG9scGhpbmZsYXNoY2FyZHMuY29tIiwiYXVkIjoiYXBpIiwic3ViIjoidU5RR2lIencxdk9EaExybTVDRWtaQ1ZoTU93MSIsImFjY2Vzc190b2tlbiI6IjRiZTA2NDNmLTFkOTgtNTczYi05N2NkLWNhOThhNjUzNDdkZCIsImFjY2Vzc190b2tlbl9yYXciOiJ0ZXN0IiwiaWF0IjoxNzI2Nzc0MTYzfQ.F-fxFitPQF-gGHyhGPGxE_zj_b8XJybqe4J_iYG66BC4Dqm4LTb8RpcDLyYUhRCcpphihpWGbdp"
}
'{
"Folder": {
"Flashcard": {
"cards": {
"cardID": {
"last_review": "15/07/2024",
"review_status": "0.0"
}
},
"flashcardID": "6796878844471389968582206160161573797336081811111331165973477783999823937257",
"flashcardName": "firstFlashCard"
},
"secondFlashcard": {
"cards": {
"cardID": {
"last_review": "15/07/2024",
"review_status": "0.0"
}
},
"flashcardID": "<string>",
"flashcardName": "secondFlashCard"
}
},
"top-level-parent-name": {
"parent-name-2": {
"parent-name-3": {
"Flashcard": {
"cards": {
"cardID": {
"last_review": "<string>",
"review_status": "<string>"
}
},
"flashcardID": "<string>",
"flashcardName": "<string>"
}
}
}
}
}Body
The identity of the user learning the flashcards.
"eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NiIsImtpZCI6ImEzMmZkZDRiMTQ2Njc3NzE5YWIyMzcyODYxYmRlZDg5In0.eyJpc3MiOiJodHRwOi8vZG9scGhpbmZsYXNoY2FyZHMuY29tIiwiYXVkIjoiYXBpIiwic3ViIjoidU5RR2lIencxdk9EaExybTVDRWtaQ1ZoTU93MSIsImFjY2Vzc190b2tlbiI6IjRiZTA2NDNmLTFkOTgtNTczYi05N2NkLWNhOThhNjUzNDdkZCIsImFjY2Vzc190b2tlbl9yYXciOiJ0ZXN0IiwiaWF0IjoxNzI2Nzc0MTYzfQ.F-fxFitPQF-gGHyhGPGxE_zj_b8XJybqe4J_iYG66BC4Dqm4LTb8RpcDLyYUhRCcpphihpWGbdp"
Response
OK
A parent folder containing flashcards.
Show child attributes
Show child attributes
The first flashcard in the current folder.
Show child attributes
Show child attributes
An object contaning the cardID of the current flashcard.
Show child attributes
Show child attributes
A unique numerical identifier of a specific card item within the flashcard. Has last_review and review_status properties.
Show child attributes
Show child attributes
The date when the card was last reviewed, formatted as dd/mm/yyyy.
"15/07/2024"
The current review status of the card, where 0.0 indicates that the card is not started; 0.x indicates that the card is actively studying; and >= 1.x indicates that the card is learned.
"0.0"
A unique numerical identifier of the current flashcard. This is different from cardID.
"6796878844471389968582206160161573797336081811111331165973477783999823937257"
The name of the current flashcard.
"firstFlashCard"
Another flashcard within the current folder.
Show child attributes
Show child attributes
An object contaning the cardID of the current flashcard.
Show child attributes
Show child attributes
A unique numerical identifier of a specific card item within the flashcard. Has last_review and review_status properties.
Show child attributes
Show child attributes
The date when the card was last reviewed, formatted as dd/mm/yyyy.
"15/07/2024"
The current review status of the card, where 0.0 indicates that the card is not started; 0.x indicates that the card is actively studying; and >= 1.x indicates that the card is learned.
"0.0"
A unique numerical identifier of the current flashcard. This is different from cardID.
The name of the current flashcard.
"secondFlashCard"
Another parent folder within the same account that contains nested folders and flashcards. It has a different naming convention from the previous folder.
Show child attributes
Show child attributes
A folder nested within the top-level-parent-name folder that further organizes flashcards.
Show child attributes
Show child attributes
A folder nested within the parent-name-2 folder, containing specific flashcards.
Show child attributes
Show child attributes
The first flashcard in the current folder.
Show child attributes
Show child attributes
An object contaning the cardID of the current flashcard.
Show child attributes
Show child attributes
A unique numerical identifier of a specific card item within the flashcard. Has last_review and review_status properties.
Show child attributes
Show child attributes
The date when the card was last reviewed, formatted as dd/mm/yyyy.
The current review status of the card, where 0.0 indicates that the card is not started; 0.x indicates that the card is actively studying; and >= 1.x indicates that the card is learned.
A unique numerical identifier of the current flashcard. This is different from cardID.
The name of the current flashcard.