Contents

List locations

Returns a list of locations in an Apple School Manager organization.

URL

GET https://api-school.apple.com/rosterapi/v1/locations

Query Parameters

NameTypeDescription
limit Optionalstring

The maximum number of locations to return. The default is 100.

pageToken Optionalstring

A token for paging through a large number of results. If the number of locations in the organization is greater than the limit parameter, pass the token returned in Locations.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
Locations

The request was successful.

401Unauthorized

The access token was invalid.

403Forbidden

You don’t have permission to access the locations.

429

The client made too many requests. The response includes an X-Retry-After header that indicates the number of seconds to wait before making another request.

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

Example

See Also

Information about locations