SKskilljar
Enrollments

List enrollments

Changed on

List the organization's enrollments (active and inactive), one row per enrollment.

Required OAuth scope: enrollments:read

get/v2/enrollments/

Request

Query parameters

filter[student.id]string nullable

Return only enrollments for the student with this opaque id. Unknown ids match nothing.

filter[student.email]string nullable

Return only enrollments for the student with this email (case-insensitive). Unknown emails match nothing.

filter[course.id]string nullable

Return only enrollments in the course with this opaque id. Unknown or malformed ids match nothing.

filter[enrolled_gte]string date-time nullable

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.

filter[enrolled_lte]string date-time nullable

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.

filter[completed_gte]string date-time nullable

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.

filter[completed_lte]string date-time nullable

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.

filter[progress_status]string nullable

Comma-separated progress states to include: completed, in_progress, not_started.

filter[domains]string nullable

Comma-separated domain names; returns only enrollments whose published course is in one of those domains. Unknown names match nothing, never error.

filter[active]boolean nullable

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.

includestring nullable

Comma-separated related resources to include in the response. Supported: purchase, student, certificate.

page[size]integer

Maximum number of records to return.

page[cursor]string nullable

Opaque cursor from the previous page's links.next.

Response

OK

metaobject nullable

Pagination metadata, e.g. {"page_size": 25}.

Changes

  • bed169429eb2Revision changes
    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added to the response property anyOf list for the response status

    • info

      removed subschema #1 from the response property anyOf list for the response status

  • 9fc34e55336dRevision changes
    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status

    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status

    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status

    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status

    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status

    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status