Sign in

v1

latestOpenAPI 3.1.02026-08-04164270844.7 KB
Classrooms

List all slots in a classroom

🔑

Required OAuth scope: classrooms:read.

📖

This endpoint is paginated with a page size of 100 classroom slots. For more information, see the Pagination guide.

Lists all slots in a given classroom.

get/api/v2/classrooms/{classroomId}/slots

Path parameters

classroomIdstring ObjectId required
Example:507f1f77bcf86cd799439011

The unique ID of the classroom.

Query parameters

ltstring date-time

Filter on dates lower than the given one

gtestring date-time

Filter on dates greater than or equal the given one

Filter on createdAt property with LHS bracket notation.

Expected value format is a date (YYYY-MM-DDThh:mm:ss.sssZ). The milliseconds are always set to 0.

{
  "lt": "2020-01-01T10:30:26.000Z",
  "gte": "2020-01-01T10:30:26.000Z"
}
ltstring date-time

Filter on dates lower than the given one

gtestring date-time

Filter on dates greater than or equal the given one

Filter on modifiedAt property with LHS bracket notation.

Expected value format is a date (YYYY-MM-DDThh:mm:ss.sssZ). The milliseconds are always set to 0.

{
  "lt": "2020-01-01T10:30:26.000Z",
  "gte": "2020-01-01T10:30:26.000Z"
}

Headers

360-api-version'v2.0' required

The version of the API.

Response

Returns one page of 100 classroom slots.

startDatestring date-time required

The date and time when the classroom slot starts (must be before endDate), in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

endDatestring date-time required

The date and time when the classroom slot ends (must be after startDate), in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

reportedDurationnumber required

The reported duration of the slot, in hours.

virtualboolean required

True when the slot is a virtual classroom, false otherwise.

maxCapacitynumber

The maximum number of registrations allowed in the slot. Learners won't be able to self-enroll on this slot if this number is reached.

_idstring ObjectId required

The unique ID of the classroom slot.

classroomIdstring ObjectId required

The unique ID of the classroom the slot is linked to.

createdAtstring date-time

The date and time when the classroom slot has been created, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

namestring required

The title of the classroom slot.

locationstring required

The location of the classroom slot, being either a URL or a physical address.

trainerIdsstring[] required

The list of unique user IDs of trainers in charge of the slot (users must exist in the company).

mediaIdsstring[] required

The list of medias unique identifiers linked to the classroom slot.

modifiedAtstring date-time

The date and time when the classroom slot has been updated, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

timezonestring

The timezone of the slot in the format Continent[/Country]/City defined by TZ database.

webinarProviderstring

If the classroom is setup through a webinar integration, contains the name of the integration.

Example response

[
  {
    "reportedDuration": 1,
    "maxCapacity": 10,
    "_id": "507f1f77bcf86cd799439011",
    "classroomId": "507f1f77bcf86cd799439011",
    "name": "My awesome classroom slot",
    "location": "https://meet.google.com/kdf-zkfz-hje",
    "trainerIds": [
      "507f1f77bcf86cd799439011"
    ],
    "mediaIds": [
      "507f1f77bcf86cd799439011"
    ],
    "timezone": "Europe/Paris",
    "webinarProvider": "Microsoft Teams",
    "context": {
      "_id": "507f1f77bcf86cd799439011"
    }
  }
]