Skip to main content
GET
https://app.medisync.me
/
api
/
transcriptions
/
{appointmentId}
Get Transcriptions by Appointment
curl --request GET \
  --url https://app.medisync.me/api/transcriptions/{appointmentId} \
  --header 'Authorization: <authorization>'
{
  "success": true,
  "data": [
    {
      "_id": "<string>",
      "appointment_id": "<string>",
      "transcription": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "error": "<string>"
}

​
Overview

Retrieves all transcriptions associated with a specific appointment ID. This endpoint returns an array of transcription objects for the given appointment.
This endpoint searches for transcriptions by appointment ID, not by transcription ID. It returns all transcriptions associated with the appointment.

​
Authentication

​
Authorization
string
required
Bearer JWT token for authentication
Authorization: Bearer your_jwt_token_here

​
Path Parameters

​
appointmentId
string
required
The appointment ID to search for transcriptions (MongoDB ObjectId)
65f8a1b2c3d4e5f6789012f3

​
Response

​
success
boolean
required
Indicates if the request was successful
​
data
array
Array of transcription objects associated with the appointment
​
error
string
Error message if the request failed

​
Example Request

curl -X GET \
  'https://app.medisync.me/api/transcriptions/65f8a1b2c3d4e5f6789012f3' \
  -H 'Authorization: Bearer your_jwt_token_here'

​
Example Response

Success Response - With Transcriptions
{
  "success": true,
  "data": [
    {
      "_id": "65f8a1b2c3d4e5f6789012f7",
      "appointment_id": "65f8a1b2c3d4e5f6789012f3",
      "transcription": "Patient reports chest pain that started this morning. No shortness of breath. Vital signs stable.",
      "createdAt": "2024-03-18T10:30:00.000Z",
      "updatedAt": "2024-03-18T10:30:00.000Z"
    }
  ]
}
Success Response - No Transcriptions
{
  "success": true,
  "data": []
}
Error Response
{
  "success": false,
  "error": "Database error message"
}

​
Behavior Notes

  • Search by Appointment: The endpoint searches for transcriptions using the appointment ID, not the transcription ID
  • Array Response: Always returns an array, even if no transcriptions are found (empty array)
  • Multiple Transcriptions: Can return multiple transcriptions if an appointment has multiple transcription files
  • Authentication Required: Requires valid JWT token for access

​
Use Cases

  1. View Appointment Transcriptions: Get all transcriptions for a specific medical appointment
  2. Transcription Management: List transcriptions before processing or notes generation
  3. Appointment History: View transcription history for follow-up appointments
  4. Clinical Review: Retrieve transcription content for medical review and documentation