f8025de20169
List enrollments
List the organization's enrollments (active and inactive), one row per enrollment.
Required OAuth scope: enrollments:read
Query parameters
Return only enrollments for the student with this opaque id. Unknown ids match nothing.
Return only enrollments for the student with this opaque id. Unknown ids match nothing.
Return only enrollments for the student with this email (case-insensitive). Unknown emails match nothing.
Return only enrollments for the student with this email (case-insensitive). Unknown emails match nothing.
Return only enrollments in the course with this opaque id. Unknown or malformed ids match nothing.
Return only enrollments in the course with this opaque id. Unknown or malformed ids match nothing.
Return only enrollments created on or after this ISO 8601 timestamp. Must include a timezone offset (e.g. Z or +00:00); naive datetimes are rejected with 422.
Return only enrollments created on or after this ISO 8601 timestamp. Must include a timezone offset (e.g. Z or +00:00); naive datetimes are rejected with 422.
Return only enrollments created on or before this ISO 8601 timestamp. Must include a timezone offset (e.g. Z or +00:00); naive datetimes are rejected with 422.
Return only enrollments created on or before this ISO 8601 timestamp. Must include a timezone offset (e.g. Z or +00:00); naive datetimes are rejected with 422.
Return only enrollments completed on or after this ISO 8601 timestamp. Must include a timezone offset (e.g. Z or +00:00); naive datetimes are rejected with 422.
Return only enrollments completed on or after this ISO 8601 timestamp. Must include a timezone offset (e.g. Z or +00:00); naive datetimes are rejected with 422.
Return only enrollments completed on or before this ISO 8601 timestamp. Must include a timezone offset (e.g. Z or +00:00); naive datetimes are rejected with 422.
Return only enrollments completed on or before this ISO 8601 timestamp. Must include a timezone offset (e.g. Z or +00:00); naive datetimes are rejected with 422.
Comma-separated progress states to include: completed, in_progress, not_started.
Comma-separated progress states to include: completed, in_progress, not_started.
Comma-separated domain names; returns only enrollments whose published course is in one of those domains. Unknown names match nothing, never error.
Comma-separated domain names; returns only enrollments whose published course is in one of those domains. Unknown names match nothing, never error.
Return only active (true) or inactive (false) enrollments. Active means the enrollment is active and not expired; inactive means deactivated or past its expiry. Omit to return both.
Return only active (true) or inactive (false) enrollments. Active means the enrollment is active and not expired; inactive means deactivated or past its expiry. Omit to return both.
Comma-separated related resources to include in the response. Supported: purchase, student, certificate.
Comma-separated related resources to include in the response. Supported: purchase, student, certificate.
Maximum number of records to return.
Maximum number of records to return.
Opaque cursor from the previous page's links.next.
Opaque cursor from the previous page's links.next.
Response
OK