Skip to main content
GET
/
flashcard
/
getFlashCardById
/
{flashcardId}
Get Flashcard by ID
curl --request GET \
  --url https://api.example.com/flashcard/getFlashCardById/{flashcardId} \
  --header 'api-key: <api-key>'
{
  "_id": "65f4...",
  "orgId": "65f1c0f5a2b3c4d5e6f7a8b9",
  "userId": "user-123",
  "flashName": "Algebra Concepts",
  "flashCards": [
    {
      "term": "Variable",
      "definition": "A symbol that represents an unknown value in an equation"
    },
    {
      "term": "Coefficient",
      "definition": "A number that multiplies a variable"
    }
  ],
  "createdAt": "2024-03-12T10:00:00.000Z",
  "updatedAt": "2024-03-12T10:00:00.000Z"
}

​
Description

This endpoint retrieves the details of a specific flashcard set using its unique flashcardId. It returns all information about the flashcard set, including its terms, definitions, and metadata. Use this endpoint to fetch flashcard data for study, review, or display in your application.

​
Example Request

curl -X GET \
  'https://b2b-api-backend-95487.ondigitalocean.app/flashcard/getFlashCardById/{flashcardId}' \
  -H 'accept: application/json' \
  -H 'api-key: <your-api-key>'

​
Example Value

{
  "_id": "65f4...",
  "orgId": "65f1c0f5a2b3c4d5e6f7a8b9",
  "userId": "user-123",
  "flashName": "Algebra Concepts",
  "flashCards": [
    {
      "term": "Variable",
      "definition": "A symbol that represents an unknown value in an equation"
    },
    {
      "term": "Coefficient",
      "definition": "A number that multiplies a variable"
    }
  ],
  "createdAt": "2024-03-12T10:00:00.000Z",
  "updatedAt": "2024-03-12T10:00:00.000Z"
}

​
Authentication

​
api-key
string
required
Your organisation’s API key

​
Path Parameters

​
flashcardId
string
required
The ID of the flashcard set to retrieve

​
Response

​
_id
string
MongoDB ObjectId of the flashcard
​
orgId
string
Organisation ID
​
userId
string
User identifier
​
flashName
string
Name of the flashcard set
​
flashCards
array
Array of flashcard items
​
createdAt
string
Timestamp of creation
​
updatedAt
string
Timestamp of last update
{
  "_id": "65f4...",
  "orgId": "65f1c0f5a2b3c4d5e6f7a8b9",
  "userId": "user-123",
  "flashName": "Algebra Concepts",
  "flashCards": [
    {
      "term": "Variable",
      "definition": "A symbol that represents an unknown value in an equation"
    },
    {
      "term": "Coefficient",
      "definition": "A number that multiplies a variable"
    }
  ],
  "createdAt": "2024-03-12T10:00:00.000Z",
  "updatedAt": "2024-03-12T10:00:00.000Z"
}