Sign in

v1

latestOpenAPI 3.1.02026-08-04164270844.7 KB
Classrooms

List all registrations in a classroom

🔑

Required OAuth scope: classrooms:read.

📖

This endpoint is paginated with a page size of 2,000 slot registrations. For more information, see the Pagination guide.

Lists all users registered to any slot in the given classroom.

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

Path parameters

classroomIdstring ObjectId required
Example:507f1f77bcf86cd799439011

The unique ID of the classroom.

Headers

360-api-version'v2.0' required

The version of the API.

Response

Returns one page of 2000 slot registrations.

_idstring ObjectId required

The unique ID of the classroom slot registration.

archivedAtstring date-time

The date and time when the slot registration was archived from the path session, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

userIdstring ObjectId required

The unique ID of the registered user.

attendanceDurationnumber

If the classroom is setup through a webinar integration, contains the reported duration of the attendance in milliseconds.

createdAtstring date-time

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

hasAttendedboolean

The attendance status of the registration.

modifiedAtstring date-time

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

pathIdstring ObjectId

The ID of the path in which this registration was made (if any).

status'archived' | 'published' required

The status of the slot registration.

classroomSlotIdstring ObjectId required

The unique ID of the classroom slot.

Example response

[
  {
    "_id": "507f1f77bcf86cd799439011",
    "userId": "507f1f77bcf86cd799439011",
    "attendanceDuration": 60,
    "pathId": "507f1f77bcf86cd799439011",
    "classroomSlotId": "507f1f77bcf86cd799439011"
  }
]