curl --request GET \
--url https://app.hipp.health/api/v1/sessions/{sessionId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.hipp.health/api/v1/sessions/{sessionId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.hipp.health/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://app.hipp.health/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 => [
"Authorization: Bearer <token>"
],
]);
$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://app.hipp.health/api/v1/sessions/{sessionId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.hipp.health/api/v1/sessions/{sessionId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.hipp.health/api/v1/sessions/{sessionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"publicId": "apt_1a2b3c4d5e",
"title": "John Doe — Adaptive behavior treatment",
"status": "CONFIRMED",
"startTime": "2026-01-05T14:00:00.000Z",
"endTime": "2026-01-05T15:00:00.000Z",
"isSupervision": false,
"isClientPresent": true,
"placeOfService": "TELEHEALTH_PROVIDED_ELSEWHERE",
"locationId": "loc_1a2b3c",
"technicianId": "usr_tech123",
"clientId": "usr_client789",
"isBillable": true,
"isTelehealth": false,
"clinicianId": "usr_clin456",
"providerLocationId": "loc_9f8e7d",
"services": "svc_1a2b3c"
}{
"message": "Validation Error",
"statusCode": 400,
"validationErrors": [
{
"code": "invalid_type",
"message": "Required",
"path": [
"email"
]
}
]
}{
"error": "API key required",
"statusCode": 401
}{
"error": "Access denied",
"statusCode": 403
}{
"error": "Session not found",
"statusCode": 404
}{
"error": "Method not allowed",
"statusCode": 405
}Get Session by ID
Retrieve a single session (appointment) by its public id.
curl --request GET \
--url https://app.hipp.health/api/v1/sessions/{sessionId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.hipp.health/api/v1/sessions/{sessionId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.hipp.health/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://app.hipp.health/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 => [
"Authorization: Bearer <token>"
],
]);
$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://app.hipp.health/api/v1/sessions/{sessionId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.hipp.health/api/v1/sessions/{sessionId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.hipp.health/api/v1/sessions/{sessionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"publicId": "apt_1a2b3c4d5e",
"title": "John Doe — Adaptive behavior treatment",
"status": "CONFIRMED",
"startTime": "2026-01-05T14:00:00.000Z",
"endTime": "2026-01-05T15:00:00.000Z",
"isSupervision": false,
"isClientPresent": true,
"placeOfService": "TELEHEALTH_PROVIDED_ELSEWHERE",
"locationId": "loc_1a2b3c",
"technicianId": "usr_tech123",
"clientId": "usr_client789",
"isBillable": true,
"isTelehealth": false,
"clinicianId": "usr_clin456",
"providerLocationId": "loc_9f8e7d",
"services": "svc_1a2b3c"
}{
"message": "Validation Error",
"statusCode": 400,
"validationErrors": [
{
"code": "invalid_type",
"message": "Required",
"path": [
"email"
]
}
]
}{
"error": "API key required",
"statusCode": 401
}{
"error": "Access denied",
"statusCode": 403
}{
"error": "Session not found",
"statusCode": 404
}{
"error": "Method not allowed",
"statusCode": 405
}Get Session by ID
Retrieve a single session (appointment) by its public id. The session must belong to the organization that owns the API key.Headers
Authorization: Bearer <your-api-key>
Path Parameters
sessionId(required): Session public id
Success Response (200)
The response shape depends onisBillable. A billable session exposes isTelehealth, clinicianId and services (and never nonBillableCode):
{
"publicId": "apt_1a2b3c4d5e",
"title": "John Doe — Adaptive behavior treatment",
"status": "CONFIRMED",
"startTime": "2026-01-05T14:00:00.000Z",
"endTime": "2026-01-05T15:00:00.000Z",
"isSupervision": false,
"isClientPresent": true,
"placeOfService": "HOME",
"locationId": "loc_1a2b3c",
"technicianId": "usr_tech123",
"clientId": "usr_client789",
"isBillable": true,
"isTelehealth": false,
"clinicianId": "usr_clin456",
"providerLocationId": "loc_9f8e7d",
"services": "svc_1a2b3c"
}
nonBillableCode instead (and omits isTelehealth, clinicianId and services):
{
"publicId": "apt_9z8y7x",
"title": "Travel",
"status": "CONFIRMED",
"startTime": "2026-01-05T12:00:00.000Z",
"endTime": "2026-01-05T12:30:00.000Z",
"isSupervision": false,
"isClientPresent": false,
"placeOfService": "OTHER",
"locationId": "loc_1a2b3c",
"technicianId": "usr_tech123",
"clientId": null,
"isBillable": false,
"nonBillableCode": "nbc_1a2b3c"
}
Error Responses
400 - Bad Request
Returned whensessionId is not a well-formed public id (for example it contains a null byte or other invalid characters):
{
"message": "Validation Error",
"statusCode": 400,
"validationErrors": [
{
"code": "custom",
"path": ["sessionId"],
"message": "sessionId is invalid"
}
]
}
401 - Unauthorized
{
"error": "API key required",
"statusCode": 401
}
403 - Forbidden
{
"error": "Access denied",
"statusCode": 403
}
404 - Not Found
{
"error": "Session not found",
"statusCode": 404
}
Examples
cURL Example
curl -X GET "https://app.hipp.health/api/v1/sessions/apt_1a2b3c4d5e" \
-H "Authorization: Bearer your-api-key"
JavaScript Example
const getSession = async (sessionId) => {
const response = await fetch(
`https://app.hipp.health/api/v1/sessions/${sessionId}`,
{
method: "GET",
headers: {
Authorization: "Bearer your-api-key",
},
}
);
if (!response.ok) {
const error = await response.json();
throw new Error(error.error || "Failed to fetch session");
}
return response.json();
};
// Usage
try {
const session = await getSession("apt_1a2b3c4d5e");
console.log("Session:", session);
} catch (error) {
console.error("Error fetching session:", error.message);
}
Authorizations
API key authentication. Include your API key in the Authorization header as 'Bearer '
Path Parameters
Session public identifier
1Response
Successful response
- Option 1
- Option 2
A scheduled session (appointment). The shape depends on isBillable: billable sessions expose isTelehealth, clinicianId and services; non-billable sessions expose nonBillableCode instead.
"apt_1a2b3c4d5e"
"John Doe — Adaptive behavior treatment"
Scheduling status of the session. Matched exactly (uppercase); any other value returns a 400.
CONFIRMED, UNCONFIRMED, DECLINED, PATIENT_NO_SHOW, REQUESTED_TO_CANCEL Session start instant in UTC (ISO-8601).
"2026-01-05T14:00:00.000Z"
Session end instant in UTC (ISO-8601).
"2026-01-05T15:00:00.000Z"
false
true
CMS place-of-service classification for the session
TELEHEALTH_PROVIDED_ELSEWHERE, TELEHEALTH_PROVIDED_IN_PATIENT_HOME, OFFICE, HOME, SCHOOL, OTHER, TEMPORARY_LODGING, PLACE_OF_EMPLOYMENT, COMMUNITY_MENTAL_HEALTH_CENTER Public id of the session location.
"loc_1a2b3c"
Public id of the assigned technician, if any.
"usr_tech123"
Public id of the client, if any.
"usr_client789"
Always true for billable sessions.
true false
Public id of the assigned clinician, if any.
"usr_clin456"
Public id of the provider location the care was delivered from, if any.
"loc_9f8e7d"
Public id of the billable service line rendered. A session bills exactly one service line.
"svc_1a2b3c"