API Documentation
Account
- Create account
Card management
- Create flashcard
- Create folder
- Get all cards
- Get flashcard
- Get flashcard item
- Get today cards
- Move flashcard set
Goals
- Create card goal
- Create xp goal
- Edit card goal
- Create xp goal
- Update goal status
- Delete goal
Statistics
- Calculate streak
- Get heatmap
- Update heatmap
Get All Cards
Get all the flashcards created by a user.
curl --request POST \
--url http://dolphinflashcards.com/api/get-all-cards \
--header 'Content-Type: application/json' \
--data '{
"userID": "user1"
}'
{
"Folder": {
"Flashcard": {
"cards": {
"cardID": {
"last_review": "<string>",
"review_status": "<string>"
}
},
"flashcardID": "<string>",
"flashcardName": "<string>"
},
"secondFlashcard": {
"cards": {
"cardID": {
"last_review": "<string>",
"review_status": "<string>"
}
},
"flashcardID": "<string>",
"flashcardName": "<string>"
}
},
"top-level-parent-name": {
"parent-name-2": {
"parent-name-3": {
"Flashcard": {
"cards": {
"cardID": {
"last_review": "<string>",
"review_status": "<string>"
}
},
"flashcardID": "<string>",
"flashcardName": "<string>"
}
}
}
}
}
Body
Identifies the user who wants to retrieve their flashcards.
"user1"
Response
A parent folder containing flashcards.
The first flashcard in the current folder.
An object contaning the cardID
of the current flashcard.
A unique numerical identifier of a specific card item within the flashcard. Has last_review
and review_status
properties.
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.
The second flashcard in the current folder.
An object contaning the cardID
of the current flashcard.
A unique numerical identifier of a specific card item within the flashcard. Has last_review
and review_status
properties.
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.
Another parent folder within the same account that contains nested folders and flashcards. It has a different naming convention from the previous folder.
A folder nested within the top-level-parent-name
folder that further organizes flashcards.
A folder nested within the parent-name-2
folder, containing specific flashcards.
The first flashcard in the current folder.
An object contaning the cardID
of the current flashcard.
A unique numerical identifier of the current flashcard. This is different from cardID
.
The name of the current flashcard.
curl --request POST \
--url http://dolphinflashcards.com/api/get-all-cards \
--header 'Content-Type: application/json' \
--data '{
"userID": "user1"
}'
{
"Folder": {
"Flashcard": {
"cards": {
"cardID": {
"last_review": "<string>",
"review_status": "<string>"
}
},
"flashcardID": "<string>",
"flashcardName": "<string>"
},
"secondFlashcard": {
"cards": {
"cardID": {
"last_review": "<string>",
"review_status": "<string>"
}
},
"flashcardID": "<string>",
"flashcardName": "<string>"
}
},
"top-level-parent-name": {
"parent-name-2": {
"parent-name-3": {
"Flashcard": {
"cards": {
"cardID": {
"last_review": "<string>",
"review_status": "<string>"
}
},
"flashcardID": "<string>",
"flashcardName": "<string>"
}
}
}
}
}