v1

latestOpenAPI 3.1.02026-08-04164270844.7 KB

Classrooms

List all classrooms

🔑

Required OAuth scope: classrooms:read.

📖

This endpoint is paginated with a page size of 500 classrooms. For more information, see the Pagination guide.

Lists all classrooms in your platform.

get/api/v2/classrooms

Query parameters

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 groupId property with LHS bracket notation.

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

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

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 500 classrooms.

groupIdstring ObjectId required

The unique ID of the creation group of the classroom.

_idstring ObjectId required

The unique ID of the classroom.

createdAtstring date-time

The date at which the classroom was created, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

namestring required

The title of the classroom.

mediaIdsstring[] required

The list of unique IDs of the medias assigned to this classroom. These attachments will be sent by email to registered learners.

messagestring

Complementary information about the classroom. This information will be sent by email to registered learners.

modifiedAtstring date-time

The date at which the classroom was last modified, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

trainingObjectivestring

The training objective of the classroom.

Example response

[
  {
    "groupId": "507f1f77bcf86cd799439011",
    "_id": "507f1f77bcf86cd799439011",
    "name": "Security Conference",
    "mediaIds": [
      "507f1f77bcf86cd799439011"
    ],
    "message": "Be sure to have read all the attachments before the conference.",
    "trainingObjective": "Learn the security rules of the company."
  }
]