Contents

Read a class

Read a class from an Apple School Manager organization.

URL

GET https://api-school.apple.com/rosterapi/v1/classes/{classId}

Path Parameters

NameTypeDescription
classId Requiredstring

The identifier from the class. Use the id field from the Class object.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
Class

The request was successful.

401Unauthorized

The access token was invalid.

403Forbidden

Access to the requested class was forbidden.

404Not Found

The server didn’t find a class with the given classId in the organization.

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

Example

See Also

Information about classes