DRAFT Get therapy sessions

DRAFT Retrieves a list of therapy sessions. You can filter the results by partner appointment ID. If no filtering criteria are provided, the endpoint returns a paginated list of all sessions available to the caller.

Query Parameters

partnerAppointmentId string
Partner-specific appointment ID. If provided, retrieves all sessions that match the given partner ID.
page integer
Possible values: >= 1
Default value: 1
Page number for paginated results (defaults to 1).
size integer
Possible values: >= 1 and <= 100
Default value: 10
Number of items per page (defaults to 10).

Responses

application/json

Schema
Example (from schema)

Schema

items object[]
List of therapy sessions matching the filter criteria.
Array [
sessionId string required
Id of session.
noteTemplateIds string[] required
Optional list of default note template ids for the user.
date string
Date and time when session was created. ISO 8601 format.
providerUserId string required
Id of the provider user.
clientUserIds string[] required
Ids of the client users that participated in the session.
state TherapySessionStateResponse required
Possible values: [InProgress, Processing, Done, Error]
State of the session.
]
page integer
Current page number.
size integer
Number of results per page.
totalItems integer
Total number of results matching the filter criteria.

{
  "items": [
    {
      "sessionId": "string",
      "noteTemplateIds": [
        "2fb81b0a-611b-11ed-9b6a-0242ac120002"
      ],
      "date": "2024-01-01T12:00:00Z",
      "providerUserId": "string",
      "clientUserIds": [
        "string"
      ],
      "state": "InProgress"
    }
  ],
  "page": 0,
  "size": 0,
  "totalItems": 0
}

DRAFT Get therapy sessions​

DRAFT Get therapy sessions