# Dolphin Flashcard

## Docs

- [Authentication](https://docs.dolphinflashcards.com/api-reference/authentication.md)
- [Create account](https://docs.dolphinflashcards.com/api-reference/endpoint/account/create-account.md): Create a new user account.
- [Sign in](https://docs.dolphinflashcards.com/api-reference/endpoint/account/sign-in.md): Create a new user account.
- [Add a flashcard to a shared folder (owner only)](https://docs.dolphinflashcards.com/api-reference/endpoint/card-management/add-flashcard-to-shared-folder.md)
- [Copy shared flashcard to personal collection](https://docs.dolphinflashcards.com/api-reference/endpoint/card-management/copy-shared-flashcard-to-personal.md)
- [Create flashcard](https://docs.dolphinflashcards.com/api-reference/endpoint/card-management/create-flashcard.md): Create or edit a flashcard set for a user. Flashcards contain front, back, review status, and last review date properties.
- [Create Folder](https://docs.dolphinflashcards.com/api-reference/endpoint/card-management/create-folder.md): Create a folder for the user.
- [Create New Shared Folder](https://docs.dolphinflashcards.com/api-reference/endpoint/card-management/create-shared-folder.md)
- [Delete a shared folder (owner only)](https://docs.dolphinflashcards.com/api-reference/endpoint/card-management/delete-shared-folder.md)
- [Generate or regenerate invite link (owner only)](https://docs.dolphinflashcards.com/api-reference/endpoint/card-management/generate-shared-folder-invite.md)
- [Get All Cards](https://docs.dolphinflashcards.com/api-reference/endpoint/card-management/get-all-cards.md): Get all the flashcards created by a user.
- [Get Flashcard](https://docs.dolphinflashcards.com/api-reference/endpoint/card-management/get-flashcard.md): Retrieve a flashcard set based on the specified name, folder, and user ID. Returns null if the request body contains an invalid flashcard name and/or folder name
- [Get Flashcard](https://docs.dolphinflashcards.com/api-reference/endpoint/card-management/get-flashcard-1.md): Retrieve a flashcard set based on the specified name, folder, and user ID. Returns null if the request body contains an invalid flashcard name and/or folder name.
- [Get Flashcard Item](https://docs.dolphinflashcards.com/api-reference/endpoint/card-management/get-flashcard-item.md): Get a flashcard item based on the card ID. Flashcard sets store multiple flashcard items, which are the individual flashcards.
- [Get Flashcard Item](https://docs.dolphinflashcards.com/api-reference/endpoint/card-management/get-flashcard-item-1.md): Get a flashcard item based on the card ID. Flashcard sets store multiple flashcard items, which are the individual flashcards.
- [Get details of a specific shared folder](https://docs.dolphinflashcards.com/api-reference/endpoint/card-management/get-shared-folder.md)
- [Get all flashcards in a shared folder](https://docs.dolphinflashcards.com/api-reference/endpoint/card-management/get-shared-folder-flashcards.md)
- [Get all members of a shared folder](https://docs.dolphinflashcards.com/api-reference/endpoint/card-management/get-shared-folder-members.md)
- [Get all shared folders for a user](https://docs.dolphinflashcards.com/api-reference/endpoint/card-management/get-shared-folders.md)
- [Get Today Cards](https://docs.dolphinflashcards.com/api-reference/endpoint/card-management/get-today-cards.md): 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.
- [Import flashcards from an Anki .apkg file](https://docs.dolphinflashcards.com/api-reference/endpoint/card-management/import-anki-flashcards.md): Imports flashcards from an Anki deck package (.apkg) and stores them in the specified folder
- [Import Flashcard](https://docs.dolphinflashcards.com/api-reference/endpoint/card-management/import-flashcard.md): Import flashcards from a CSV file. The API accepts CSV files and creates flashcards under the specified folder.
- [Import flashcards from Quizlet](https://docs.dolphinflashcards.com/api-reference/endpoint/card-management/import-from-quizlet.md): Add a Quizlet set exported as text to the user's flashcards.
- [Join shared folder using invite link](https://docs.dolphinflashcards.com/api-reference/endpoint/card-management/join-shared-folder.md)
- [Leave a shared folder](https://docs.dolphinflashcards.com/api-reference/endpoint/card-management/leave-shared-folder.md)
- [Move Flashcard Set](https://docs.dolphinflashcards.com/api-reference/endpoint/card-management/move-flashcard-set.md): Move a flashcard set to a new location. Folder locations, such as `currentLocation` or `moveLocation`, are in the format `myfolder1/myfolder2`. If the card is in the root folder, the folder path should be an empty string `""`.
- [Remove a flashcard from a shared folder (owner only)](https://docs.dolphinflashcards.com/api-reference/endpoint/card-management/remove-flashcard-from-shared-folder.md)
- [Remove a user from a shared folder (owner only)](https://docs.dolphinflashcards.com/api-reference/endpoint/card-management/remove-user-from-shared-folder.md)
- [Rename a shared folder (owner only)](https://docs.dolphinflashcards.com/api-reference/endpoint/card-management/rename-shared-folder.md)
- [Search](https://docs.dolphinflashcards.com/api-reference/endpoint/card-management/search.md): Search for a flashcard by it's title. The flashcard could be owned by any user
- [Transfer ownership of a shared folder](https://docs.dolphinflashcards.com/api-reference/endpoint/card-management/transfer-shared-folder-ownership.md)
- [Update progress for cards in a shared flashcard set](https://docs.dolphinflashcards.com/api-reference/endpoint/card-management/update-shared-card-progress.md)
- [Create Card Goal](https://docs.dolphinflashcards.com/api-reference/endpoint/goal/create-card-goal.md): Create a card goal for the user. Card goals have the following properties: `ID`, `type` (XP), `title`, `end date`, `status` (failed, completed, or in progress), `fail date` (if failed), and `data storing` (cards revised so far, starting XP, desired cards to revise). A card goal is similar to an XP g…
- [Create XP Goal](https://docs.dolphinflashcards.com/api-reference/endpoint/goal/create-xp-goal.md): Create an experience points (XP) goal for the user. XP goals have an `ID`, `type`, `title`, `end date`, `status` (failed, completed, or in progress), `fail date` (if failed), and `data storing` (start date, starting XP, desired XP) properties.
- [Delete Goal](https://docs.dolphinflashcards.com/api-reference/endpoint/goal/delete-goal.md): Delete a user's goal.
- [Edit Card Goal](https://docs.dolphinflashcards.com/api-reference/endpoint/goal/edit-card-goal.md): Edit an existing card goal for the user.
- [Edit XP Goal](https://docs.dolphinflashcards.com/api-reference/endpoint/goal/edit-xp-goal.md): Edit an existing experience points (XP) goal for the user.
- [Update Goal Status](https://docs.dolphinflashcards.com/api-reference/endpoint/goal/update-goal-status.md): Update the status of a goal. The possible values for the status of a goal are `completed`, `in progress`, or `failed`. Returns an empty object when the jwtToken provided is invalid.
- [Create Quest](https://docs.dolphinflashcards.com/api-reference/endpoint/quest/create-quest.md): Create a new quest and add the user as a participant(owner from the quest).
- [Delete Quest](https://docs.dolphinflashcards.com/api-reference/endpoint/quest/delete-quest.md): Delete a quest if the user is the owner.
- [Get Quests](https://docs.dolphinflashcards.com/api-reference/endpoint/quest/get-quests.md): Get all quests for the user, filtered by optional query parameters.
- [Invite to Quest](https://docs.dolphinflashcards.com/api-reference/endpoint/quest/invite-to-quest.md): Invite another user to participate in a quest.
- [Update Invite Status](https://docs.dolphinflashcards.com/api-reference/endpoint/quest/update-invite-status.md): Update the status of a quest invite (accept, decline, etc).
- [Update Quest Progress](https://docs.dolphinflashcards.com/api-reference/endpoint/quest/update-quest-progress.md): Update the progress for the quest and for a user in a quest.
- [Calculate Streak](https://docs.dolphinflashcards.com/api-reference/endpoint/statistics/calculate-streak.md): Calculate the user's streak, and increase it if necessary.
- [Get Heatmap](https://docs.dolphinflashcards.com/api-reference/endpoint/statistics/get-heatmap.md): Retrieve the user's heatmap data.
- [Update Heat map](https://docs.dolphinflashcards.com/api-reference/endpoint/statistics/update-heat-map.md): Updates the user's heatmap data when their streak is modified.
- [Overview](https://docs.dolphinflashcards.com/api-reference/introduction.md)
- [Premium Modules](https://docs.dolphinflashcards.com/conceptual-docs/activatingpremiumrepo.md)
- [Architecture Diagrams](https://docs.dolphinflashcards.com/conceptual-docs/architecturediagrams.md)
- [Backend](https://docs.dolphinflashcards.com/conceptual-docs/backend.md)
- [Frontend](https://docs.dolphinflashcards.com/conceptual-docs/frontend.md)
- [How it Works](https://docs.dolphinflashcards.com/conceptual-docs/howitworks.md)
- [Introduction](https://docs.dolphinflashcards.com/conceptual-docs/introduction.md)
- [Quickstart](https://docs.dolphinflashcards.com/conceptual-docs/quickstart.md)
- [Introduction](https://docs.dolphinflashcards.com/conceptual-docs/tutorialintro.md)
- [Unit Tests](https://docs.dolphinflashcards.com/conceptual-docs/unittests.md)
- [Useful Commands](https://docs.dolphinflashcards.com/conceptual-docs/usefulcommands.md)
- [Why Dolphin Flashcards?](https://docs.dolphinflashcards.com/conceptual-docs/whydolphin.md)
- [Changelog](https://docs.dolphinflashcards.com/extras/changelog.md)
- [Terminology](https://docs.dolphinflashcards.com/extras/terminology.md): Descriptions of terms used in this documentation.

## OpenAPI Specs

- [openapi](https://docs.dolphinflashcards.com/api-reference/openapi.yaml)

## Optional

- [Join the team on Slack](https://join.slack.com/t/dolphinflashcards/shared_invite/zt-2pfey518m-Zw5D3xQbW94_PZAjDfLSUQ)
- [Github](https://github.com/jacob-macleod/Dolphin-Flashcard-App)
- [Website](http://dolphinflashcards.com)