Get Recordings by Appointment

curl --request GET \
  --url https://api.example.com/recordings/{appointmentId} \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.example.com/recordings/{appointmentId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/recordings/{appointmentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/recordings/{appointmentId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/recordings/{appointmentId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": [
    {
      "_id": "<string>",
      "appointment_id": "<string>",
      "recording_url": "<string>",
      "recording_key": "<string>",
      "append_recordings": [
        {}
      ],
      "duration_seconds": 123,
      "file_size_bytes": 123,
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ]
}

GET

recordings

{appointmentId}

Get Recordings by Appointment

curl --request GET \
  --url https://api.example.com/recordings/{appointmentId} \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.example.com/recordings/{appointmentId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/recordings/{appointmentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/recordings/{appointmentId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/recordings/{appointmentId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": [
    {
      "_id": "<string>",
      "appointment_id": "<string>",
      "recording_url": "<string>",
      "recording_key": "<string>",
      "append_recordings": [
        {}
      ],
      "duration_seconds": 123,
      "file_size_bytes": 123,
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ]
}

Overview

Returns the recording(s) stored for a specific appointment. Recordings are looked up by appointment_id, so the path value is an appointment ObjectId, not a recording id. The caller must be the appointment’s owning doctor. Because only one recording may exist per appointment, the returned data array contains zero or one recording in practice.

The path value is an appointment ObjectId. The endpoint returns the recordings whose appointment_id matches it.

Authentication

string

required

Bearer JWT token. The calling user is derived from the token.

Authorization: Bearer <JWT>

Path Parameters

string

required

The appointment ObjectId. Recordings are looked up by appointment_id; the caller must be the appointment’s owning doctor.

665f8a1b2c3d4e5f6789012f3

Response

boolean

required

Indicates whether the request succeeded.

array

Array of recording objects for the appointment (0 or 1 element in practice).

Show Recording Object

string

Unique recording identifier.

string

The associated appointment ObjectId.

string

Internal storage reference for the stored recording. Not a fetchable link. Treat as opaque — its format is not part of the API contract.

string

Storage key of the recording file.

array

Additional recording segments attached to this recording.

number

Recording duration in seconds. May be null.

number

File size in bytes. May be null.

string

Creation timestamp (ISO 8601).

string

Last-update timestamp (ISO 8601).

Additional fields (for example merged_recording, replaced_recording, __v) may appear on the recording object. Treat any field not documented here as opaque.

Example Request

curl -X GET \
  'https://app.medisync.me/api/recordings/665f8a1b2c3d4e5f6789012f3' \
  -H 'Authorization: Bearer <JWT>'

const response = await fetch(
  'https://app.medisync.me/api/recordings/665f8a1b2c3d4e5f6789012f3',
  {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer <JWT>'
    }
  }
);

const result = await response.json();

import requests

headers = {'Authorization': 'Bearer <JWT>'}

response = requests.get(
    'https://app.medisync.me/api/recordings/665f8a1b2c3d4e5f6789012f3',
    headers=headers
)

result = response.json()

Example Response

Success (200) - Recording Present

{
  "success": true,
  "data": [
    {
      "_id": "665f8a1b2c3d4e5f6789012f4",
      "appointment_id": "665f8a1b2c3d4e5f6789012f3",
      "recording_url": "<internal storage reference>",
      "recording_key": "<internal storage reference>",
      "append_recordings": [],
      "duration_seconds": null,
      "file_size_bytes": 4831200,
      "createdAt": "2026-06-30T10:30:00.000Z",
      "updatedAt": "2026-06-30T10:30:00.000Z"
    }
  ]
}

Success (200) - No Recording On File

{
  "success": true,
  "data": []
}

Error Responses

401 Unauthorized

{
  "success": false,
  "message": "Unauthorized"
}

403 Forbidden (not the owning doctor)

{
  "success": false,
  "error": "Forbidden"
}

404 Appointment Not Found

{
  "success": false,
  "error": "Appointment not found"
}

The Unauthorized response uses the message field, whereas handler-level errors use the error field. Unexpected server errors return 400 { "success": false, "error": "<message>" }.

Behavior Notes

Lookup by appointment: Recordings are located by appointment_id; the path value is an appointment id.
Empty array only for existing appointments: If the appointment exists but has no recording, data is []. If the appointment does not exist, the endpoint returns 404 Appointment not found (not an empty array).
Ownership: Only the appointment’s owning doctor may read its recordings; otherwise the request returns 403 Forbidden.
At most one recording: Because uploads are limited to one recording per appointment, data holds 0 or 1 element.

Getting Started

API Reference

Authentication

User

Appointments

Recordings

Transcriptions

Notes

Documents

Get Recordings by Appointment

Overview

Authentication

Path Parameters

Response

Example Request

Example Response

Error Responses

Behavior Notes

​Overview

​Authentication

​Path Parameters

​Response

​Example Request

​Example Response

​Error Responses

​Behavior Notes

Overview

Authentication

Path Parameters

Response

Example Request

Example Response

Error Responses

Behavior Notes