v1

latestOpenAPI 3.0.02026-07-2673188210.8 KB

host

Returns a session detail

get/api/v2/host/sessions/{sessionId}

Path parameters

sessionIdnumber required

Response

idinteger required

namestring required

startsAtstring date-time required

endsAtstring date-time required

capacityinteger nullable required

bookingCountinteger nullable required

waitlistCapacityinteger nullable required

waitlistBookingCountinteger nullable required

isRecurringboolean required

isCancelledboolean required

isInPersonboolean required

isDraftboolean required

zoomLinkstring nullable required

zoomMeetingIdstring nullable required

zoomMeetingPasswordstring nullable required

onlineStreamUrlstring nullable required

onlineStreamPasswordstring nullable required

Example response

{
  "id": 1,
  "name": "Monday Morning Yoga",
  "startsAt": "2021-01-01T00:00:00Z",
  "endsAt": "2021-01-01T01:00:00Z",
  "capacity": 20,
  "bookingCount": 12,
  "waitlistCapacity": 20,
  "waitlistBookingCount": 20,
  "teacher": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "pictureUrl": "https://example.com/picture.jpg",
    "email": "johndoe@teacher.com"
  },
  "originalTeacher": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "pictureUrl": "https://example.com/picture.jpg",
    "email": "johndoe@teacher.com"
  },
  "additionalTeachers": [
    {
      "id": 1,
      "firstName": "John",
      "lastName": "Doe",
      "pictureUrl": "https://example.com/picture.jpg",
      "email": "johndoe@teacher.com"
    }
  ],
  "inPersonLocation": {
    "id": 1,
    "name": "Main Studio"
  },
  "zoomLink": "https://zoom.us/j/1234567890",
  "zoomMeetingId": "1234567890",
  "zoomMeetingPassword": "065809",
  "onlineStreamUrl": "https://example.com/online-stream",
  "onlineStreamPassword": "password123",
  "tags": [
    {
      "id": 1,
      "name": "VIP",
      "badgeLabel": "VIP",
      "badgeColor": "#fe0000"
    }
  ]
}