Get Appointment

gethttps://app.untetherlabs.com/api/v1/appointments/{appointmentId}

Request

curl -X GET 'https://app.untetherlabs.com/api/v1/appointments/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
  -H 'Authorization: Bearer $UNTETHER_API_KEY'

Response 200

{
  "createdAt": "2024-11-20T07:43:34+0000",
  "type": "video",
  "status": "upcoming",
  "providerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "memberId": "string",
  "startDate": "2024-11-20T07:43:34+0000",
  "endDate": "2024-11-20T07:43:34+0000",
  "actualStartDate": "2024-11-20T07:43:34+0000",
  "actualEndDate": "2024-11-20T07:43:34+0000",
  "location": "string",
  "cancellationDate": "2024-11-20T07:43:34+0000",
  "cancellationReason": "string"
}

Path parameters#

appointmentIduuid

Required

Response 200#

createdAtstring

Required

typestring

Required

Appointment type, company specific

statusAppointmentStatus

Required

upcoming
occurred
cancelled
no-show
re-scheduled

providerIduuid

Required

memberIdstring | null

Required

startDatestring

Required

endDatestring

Required

actualStartDatestring | null

Required

actualEndDatestring | null

Required

locationstring | null

Required

cancellationDatestring | null

Required

Only present when status = cancelled

cancellationReasonstring | null

Required

Only present when status = cancelled

Errors#

validation400

Input validation failed.

Show extension members

pathstring

messagestring

Required

appointment-not-found404

A specified appointment does not exist in the system.