List locations
Returns a list of locations in an Apple School Manager organization.
URL
GET https://api-school.apple.com/rosterapi/v1/locationsQuery Parameters
| Name | Type | Description |
|---|---|---|
limit Optional | string | The maximum number of locations to return. The default is 100. |
pageToken Optional | string | A token for paging through a large number of results. If the number of locations in the organization is greater than the |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | Locations | The request was successful. |
| 401 | Unauthorized | The access token was invalid. | |
| 403 | Forbidden | You don’t have permission to access the locations. | |
| 429 | The client made too many requests. The response includes an | ||
| 500 | Internal Server Error | The server encountered an internal error. |
Discussion
Access to the locations resource requires authorization to either the edu.users.read or edu.classes.read scope.