List educationSchools
Namespace: microsoft.graph
Important
APIs under the /beta
version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Retrieve a list of all school objects.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ❌ | ❌ | ❌ |
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 |
GET /education/schools
This method supports the OData Query Parameters to help customize the response.
Header | Value |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Don't supply a request body for this method.
If successful, this method returns a 200 OK
response code and a collection of educationSchool objects in the response body.
The following example shows a request.
GET https://graph.microsoft.com/beta/education/schools
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-type: application/json
{
"value":[
{
"id":"10001",
"displayName":"Contoso High School",
"description":"Public 9-12 high school",
"status":"active",
"externalSource":"sis",
"principalEmail":"amyr@contoso.com",
"principalName":"Amy Roebuck",
"externalPrincipalId":"14007",
"highestGrade":"12",
"lowestGrade":"9",
"schoolNumber":"10001",
"address":{
"city":"Los Angeles",
"countryOrRegion":"United States",
"postalCode":"98055",
"state":"CA",
"street":"12345 Main St."
},
"createdBy":{
"user":{
"displayName":"Susana Rocha",
"id":"14012"
}
},
"externalId":"10001",
"phone":"+1 (253) 555-0102"
}
]
}