Get session details
curl --request GET \
--url https://api.healos.ai/ext-api/v1/sessions/{sessionId} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.healos.ai/ext-api/v1/sessions/{sessionId}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.healos.ai/ext-api/v1/sessions/{sessionId}', 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.healos.ai/ext-api/v1/sessions/{sessionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$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.healos.ai/ext-api/v1/sessions/{sessionId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.healos.ai/ext-api/v1/sessions/{sessionId}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.healos.ai/ext-api/v1/sessions/{sessionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"title": "Follow-up visit",
"status": "completed",
"encounter_date": "<string>",
"start_time": "<string>",
"end_time": "<string>",
"duration_seconds": 1260,
"source": "live_saved",
"ehr_appointment_id": "<string>",
"template": {
"id": "<string>",
"name": "SOAP Note"
},
"provider": {
"id": "<string>",
"name": "Dr. Jane Smith"
},
"patient": {
"id": "481926357104938271",
"name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"date_of_birth": "1985-04-12",
"mrn": "<string>",
"external_id": "<string>"
},
"note_ids": [
"<string>"
],
"updated_at": "<string>"
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "Rate limit exceeded. Please retry after the window resets."
}Sessions
Get session details
Metadata for one session: encounter date and times, duration, status, template, the owning provider, a patient summary and the ids of the notes generated for it. Use GET /sessions//notes for note content and the transcript. Returns 404 if the session isn’t owned by your organization. Requires the notes:read scope.
GET
/
sessions
/
{sessionId}
Get session details
curl --request GET \
--url https://api.healos.ai/ext-api/v1/sessions/{sessionId} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.healos.ai/ext-api/v1/sessions/{sessionId}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.healos.ai/ext-api/v1/sessions/{sessionId}', 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.healos.ai/ext-api/v1/sessions/{sessionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$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.healos.ai/ext-api/v1/sessions/{sessionId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.healos.ai/ext-api/v1/sessions/{sessionId}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.healos.ai/ext-api/v1/sessions/{sessionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"title": "Follow-up visit",
"status": "completed",
"encounter_date": "<string>",
"start_time": "<string>",
"end_time": "<string>",
"duration_seconds": 1260,
"source": "live_saved",
"ehr_appointment_id": "<string>",
"template": {
"id": "<string>",
"name": "SOAP Note"
},
"provider": {
"id": "<string>",
"name": "Dr. Jane Smith"
},
"patient": {
"id": "481926357104938271",
"name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"date_of_birth": "1985-04-12",
"mrn": "<string>",
"external_id": "<string>"
},
"note_ids": [
"<string>"
],
"updated_at": "<string>"
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "Rate limit exceeded. Please retry after the window resets."
}Was this page helpful?

