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 Cards
Get all the flashcards created by a user.
POST
/
get-all-cards
Copy
curl --request POST \
--url http://dolphinflashcards.com/api/get-all-cards \
--header 'Content-Type: application/json' \
--data '{
"userID": "user1"
}'
Copy
{
"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
application/json
Response
200
application/json
OK. Returns the string: "User has no flashcards"
when supplied an invalid userID.
The response is of type object
.
Copy
curl --request POST \
--url http://dolphinflashcards.com/api/get-all-cards \
--header 'Content-Type: application/json' \
--data '{
"userID": "user1"
}'
Copy
{
"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>"
}
}
}
}
}
Assistant
Responses are generated using AI and may contain mistakes.