v1

latestOpenAPI 3.1.02026-08-04164270844.7 KB

Classrooms

List all registrations in a classroom slot

🔑

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 a given classroom slot.

get/api/v2/classroom-slots/{classroomSlotId}/registrations

Path parameters

classroomSlotIdstring ObjectId required

Example:507f1f77bcf86cd799439011

The unique ID of the classroom slot.

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"
}

eqboolean

Filter on values equal to the given one

Filter on hasAttended property with LHS bracket notation.

Expected value format is a boolean (true or false).

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"
}

eqstring ObjectId

Filter on values equal to the given one

nestring ObjectId

Filter on values not equal to the given one

instring[]

Filter on values including the given ones

ninstring[]

Filter on values excluding the given ones

Filter on userId property with LHS bracket notation.

Expected value format is a valid ID (24 digits or letters).

{
  "eq": "507f1f77bcf86cd799439011",
  "ne": "507f1f77bcf86cd799439011",
  "in": [
    "507f1f77bcf86cd799439011"
  ],
  "nin": [
    "507f1f77bcf86cd799439011"
  ]
}

eq'archived' | 'published'

Filter on values equal to the given one

Filter on status property with LHS bracket notation.

Expected value format is a string (archived, published).

{
  "eq": "archived"
}

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.

Example response

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