Skip to main content
GET
Get session by id

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

Path Parameters

  • sessionId (required): Session public id

Success Response (200)

The response shape depends on isBillable. A billable session exposes isTelehealth, clinicianId and services (and never nonBillableCode):
A non-billable session exposes nonBillableCode instead (and omits isTelehealth, clinicianId and services):

Error Responses

400 - Bad Request

Returned when sessionId is not a well-formed public id (for example it contains a null byte or other invalid characters):

401 - Unauthorized

403 - Forbidden

404 - Not Found

Examples

cURL Example

JavaScript Example

Authorizations

Authorization
string
header
required

API key authentication. Include your API key in the Authorization header as 'Bearer '

Path Parameters

sessionId
string
required

Session public identifier

Minimum string length: 1

Response

Successful response

A scheduled session (appointment). The shape depends on isBillable: billable sessions expose isTelehealth, clinicianId and services; non-billable sessions expose nonBillableCode instead.

publicId
string
required
Example:

"apt_1a2b3c4d5e"

title
string
required
Example:

"John Doe — Adaptive behavior treatment"

status
enum<string>
required

Scheduling status of the session. Matched exactly (uppercase); any other value returns a 400.

Available options:
CONFIRMED,
UNCONFIRMED,
DECLINED,
PATIENT_NO_SHOW,
REQUESTED_TO_CANCEL
startTime
string<date-time>
required

Session start instant in UTC (ISO-8601).

Example:

"2026-01-05T14:00:00.000Z"

endTime
string<date-time>
required

Session end instant in UTC (ISO-8601).

Example:

"2026-01-05T15:00:00.000Z"

isSupervision
boolean
required
Example:

false

isClientPresent
boolean
required
Example:

true

placeOfService
enum<string>
required

CMS place-of-service classification for the session

Available options:
TELEHEALTH_PROVIDED_ELSEWHERE,
TELEHEALTH_PROVIDED_IN_PATIENT_HOME,
OFFICE,
HOME,
SCHOOL,
OTHER,
TEMPORARY_LODGING,
PLACE_OF_EMPLOYMENT,
COMMUNITY_MENTAL_HEALTH_CENTER
locationId
string
required

Public id of the session location.

Example:

"loc_1a2b3c"

technicianId
string | null
required

Public id of the assigned technician, if any.

Example:

"usr_tech123"

clientId
string | null
required

Public id of the client, if any.

Example:

"usr_client789"

isBillable
enum<boolean>
required

Always true for billable sessions.

Available options:
true
isTelehealth
boolean
required
Example:

false

clinicianId
string | null
required

Public id of the assigned clinician, if any.

Example:

"usr_clin456"

providerLocationId
string | null
required

Public id of the provider location the care was delivered from, if any.

Example:

"loc_9f8e7d"

services
string
required

Public id of the billable service line rendered. A session bills exactly one service line.

Example:

"svc_1a2b3c"