Get enrollments
Teacher-facing view of class rosters: lists the students enrolled in the current teacher's classes, optionally filtered to one class.
GET
/++get_enrollments
Classes & Enrollment
Authentication
Requires an authenticated (logged-in) account. Also requires a registered Integrator subscription.
This endpoint requires the calling application to be registered as an Integrator. Every call must identify the registration via a registration_id parameter (or an X-Client-Id header), and authenticate using one of the following methods, selected with the subscription_method parameter:
-
referer— The request's HTTP Referer header must match one of the domains authorized for this Integrator registration. -
ip— The request's source IP address must match one of the IP addresses authorized for this Integrator registration. -
client_token— A client token issued at registration time is supplied with the request.
Register as an Integrator and configure authorized domains, IP addresses, or a client token.
Request
Content type: application/json
| Name | In | Type | Required | Description |
|---|---|---|---|---|
class_id | query | string | No | — |
Responses
| Status | Meaning |
|---|---|
200 | Successful response. |
500 | Unexpected error: ... |
401 | Unauthorized - missing or invalid Integrator authentication (registration_id/X-Client-Id, plus referer/IP/client_token). |
403 | Forbidden - the current user or Integrator registration does not have sufficient permissions. |