Get educationClass

Namespace: microsoft.graph

Retrieve a class from the system. A class is a universal group with a special property that indicates to the system that the group is a class. Group members represent the students; group admins represent the teachers in the class. If you're using the delegated token, the user will only see classes in which they are members.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) EduRoster.ReadBasic Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application EduRoster.Read.All EduRoster.ReadWrite.All

HTTP request

GET /education/classes/{id}

Optional query parameters

You can use $select to get specific group properties, including those that are not returned by default.

For more information on OData query options, see OData Query Parameters.

Request headers

Header Value
Authorization Bearer {token}. Required.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and an educationClass object in the response body.

Example

Request

Here is an example of the request.

GET https://graph.microsoft.com/v1.0/education/classes/7e4ec76c-8276-43ef-ba10-9aaa197cb212

Response

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#education/classes/$entity",
    "id": "7e4ec76c-8276-43ef-ba10-9aaa197cb212",
    "description": "Leadership 101 training",
    "displayName": "Leadership 101",
    "mailNickname": "Leadership101"
}