v1

latestOpenAPI 3.0.02026-07-2673188210.8 KB

host

Returns a list of sessions

get/api/v2/host/sessions

Query parameters

pageinteger required

Starts at 0

pageSizeinteger required

Example:10

sortOrder'ASC' | 'DESC'

sortBy'name' | 'startsAt' | 'endsAt'

Field to sort by

includeCancelledboolean

also include cancelled sessions

typesstring[]

only return specified session types

teacherIdinteger

locationIdinteger

includeChildLocationsboolean

when filtering by location, include the locations child locations

startAfterstring

startBeforestring

endAfterstring

endBeforestring

Response

Example response

{
  "pagination": {
    "pageSize": 10,
    "totalCount": 1
  },
  "payload": [
    {
      "id": 1,
      "name": "Stretching with John",
      "type": "fitness",
      "description": "Our program is designed to help you increase your flexibility and strength.",
      "startsAt": "2021-08-01T10:00:00Z",
      "endsAt": "2021-08-01T11:00:00Z",
      "durationInMinutes": 60,
      "capacity": 10,
      "bookingCount": 10,
      "teacher": {
        "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",
      "bannerImageUrl": "https://example.com/banner.jpg",
      "hostPhotoUrl": "https://example.com/host.jpg",
      "tags": [
        {
          "id": 1,
          "name": "VIP",
          "badgeLabel": "VIP",
          "badgeColor": "#fe0000"
        }
      ]
    }
  ]
}