v1

latestOpenAPI 3.0.02026-07-2673188210.8 KB

host

Get all appointment reservations

get/api/v2/host/appointments/reservations

Query parameters

pageinteger required

Starts at 0

pageSizeinteger required

Example:10

sortOrder'ASC' | 'DESC'

sortBy'startsAt'

Field to sort by

startAfterstring

startBeforestring

endAfterstring

endBeforestring

includeCancelledboolean

includeCancelledAttendeesboolean

isPaidboolean

Response

Example response

{
  "pagination": {
    "pageSize": 10,
    "totalCount": 1
  },
  "payload": [
    {
      "capacity": 10,
      "board": {
        "id": 1,
        "name": "Yoga Private Appointments"
      },
      "service": {
        "id": 1,
        "name": "Couple Massage"
      },
      "teacher": {
        "id": 1,
        "firstName": "John",
        "lastName": "Doe",
        "pictureUrl": "https://example.com/picture.jpg"
      },
      "additionalTeacher": {
        "id": 1,
        "firstName": "John",
        "lastName": "Doe",
        "pictureUrl": "https://example.com/picture.jpg"
      },
      "inPersonLocation": {
        "id": 1,
        "name": "Main Studio"
      },
      "onlineStreamUrl": "https://example.com/online-stream",
      "onlineStreamPassword": "password123",
      "appointmentAttendees": [
        {
          "attendanceStatus": "checkedIn"
        }
      ]
    }
  ]
}