Skip to main content
GET
Get sessions

Get All Sessions

Retrieve a paginated list of sessions (appointments) with optional filtering by client, staff member, and date range. Results are scoped to the organization that owns the API key.

Headers

Query Parameters

  • page (optional): Page number (1-indexed). Default: 1. Minimum: 1, Maximum: 1000000
  • pageSize (optional): Number of items per page. Default: 25. Minimum: 1, Maximum: 100
  • clientId (optional): Filter by client public id
  • technicianId (optional): Filter by staff member (technician) public id
  • clinicianId (optional): Filter by clinician public id
  • startDate (optional): Only sessions on or after this calendar date (YYYY-MM-DD). Must be on or before endDate
  • endDate (optional): Only sessions on or before this calendar date (YYYY-MM-DD)

Session Model

Each item in data has the following shape:
  • publicId: Session public id
  • title: Human-readable session title
  • status: Current scheduling status
  • startTime / endTime: Session instants in UTC (ISO-8601). Naive date + startTime/endTime supplied at creation are resolved to instants server-side using the request timezone
  • isSupervision: Session flag
  • isClientPresent: Whether the client is present for the session
  • placeOfService: CMS place-of-service enum
  • locationId: Public id of the session location
  • technicianId / clientId: Public ids of the related resources, or null
  • isBillable: Discriminates the response shape. Billable (true) sessions add isTelehealth, clinicianId, providerLocationId and services; non-billable (false) sessions add nonBillableCode instead
Billable-only fields (present when isBillable is true):
  • isTelehealth: Whether the session is delivered via telehealth
  • clinicianId: Public id of the assigned clinician, or null
  • providerLocationId: Public id of the provider location the care was delivered from, or null
  • services: Public id of the billable service line rendered
Non-billable-only field (present when isBillable is false):
  • nonBillableCode: Public id of the non-billable code

Success Response (200)

Error Responses

400 - Validation Error

401 - Unauthorized

403 - Forbidden

Examples

cURL Example

JavaScript Example

Authorizations

Authorization
string
header
required

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

Query Parameters

page
integer
default:1

Page number (1-indexed)

Required range: 1 <= x <= 1000000
pageSize
integer
default:25

Number of items per page

Required range: 1 <= x <= 100
clientId
string

Filter by client public id

technicianId
string

Filter by staff member (technician) public id

clinicianId
string

Filter by clinician public id

startDate
string<date>

Only sessions on or after this calendar date (YYYY-MM-DD). Must be on or before endDate.

Example:

"2026-01-01"

endDate
string<date>

Only sessions on or before this calendar date (YYYY-MM-DD).

Example:

"2026-12-31"

Response

Successful response

data
object[]
required

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

pagination
object
required