GET https://ed.link/api/v2/my/classes/:class_id/enrollments
Retrieve a list of all Enrollments associated with the specified Class.
Request Parameters
This query allows for standard paging parameters.
| Parameter | Location | Type | Description |
|---|---|---|---|
class_id | url | string | The UUID of the desired Class. |
$first | query | number | Returns the first n elements from the list. |
$last | query | number | Returns the last n elements from the list. |
$before | query | uuid | Returns the elements in the list that come before the specified item. |
$after | query | uuid | Returns the elements in the list that come after the specified item. |
It is best practice to use either $first or $last in conjunction with the $next value returned by the API to paginate through results.
Read More About Paging
Developer Guide
Click to Read
This query allows for filtering results.
Sample Request
axios.get('https://ed.link/api/v2/my/classes/c3cd44bc-2a9e-43c9-b32b-71e2b531604b/enrollments', {
headers: {
authorization: `Bearer ${person_access_token}`
}
});
Sample Response
{
"$data": [
{
"id": "424e67a2-8f08-4779-b380-aacb406e0ab5",
"created_date": "2021-07-13T17:45:27.674Z",
"updated_date": "2021-07-13T17:45:27.674Z",
"start_date": "2025-01-15T00:00:00.000Z",
"end_date": "2025-06-15T00:00:00.000Z",
"role": "teacher",
"primary": null,
"state": "active",
"properties": {},
"person_id": "374fad3f-c541-4b32-9f8b-46fae545dae7",
"class_id": "c3cd44bc-2a9e-43c9-b32b-71e2b531604b",
"section_id": "a17186a2-da2e-4564-974c-c551cc3357a7"
},
{
"id": "424e67a2-8f08-4779-b380-aacb406e0ab5",
"created_date": "2021-07-13T17:45:27.674Z",
"updated_date": "2021-07-13T17:45:27.674Z",
"start_date": "2025-01-15T00:00:00.000Z",
"end_date": "2025-06-15T00:00:00.000Z",
"role": "student",
"primary": null,
"state": "active",
"properties": {},
"person_id": "63acc741-7633-453c-9bfd-75ae1ac34533",
"class_id": "c3cd44bc-2a9e-43c9-b32b-71e2b531604b",
"section_id": "c3534b6a-42d5-4004-9de0-48184eb9a456"
}
],
"$request": "00000000-0000-0000-0000-000000000000"
}