For Developers

List Students

GET https://ed.link/api/v2/my/classes/:class_id/students

Retrieve a list of People with a student Enrollment in the specified Class.

Request Parameters

This query allows for standard paging parameters.

ParameterLocationTypeDescription
class_idurlstring

The UUID of the desired Class.

$firstquerynumber

Returns the first n elements from the list.

$lastquerynumber

Returns the last n elements from the list.

$beforequeryuuid

Returns the elements in the list that come before the specified item.

$afterqueryuuid

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.

This query allows for filtering results.

Sample Request

axios.get('https://ed.link/api/v2/my/classes/c3cd44bc-2a9e-43c9-b32b-71e2b531604b/students', {
    headers: {
        authorization: `Bearer ${person_access_token}`
    }
});

Sample Response

{
    "$data": [
        {
            "id": "63acc741-7633-453c-9bfd-75ae1ac34533",
            "created_date": "2021-07-13T17:45:39.937Z",
            "updated_date": "2021-07-13T17:45:39.937Z",
            "first_name": "George",
            "middle_name": "Oscar",
            "last_name": "Bluth",
            "display_name": "Gob Bluth",
            "picture_url": "https://static.wikia.nocookie.net/arresteddevelopment/images/7/79/GOB_on_segway.jpg",
            "roles": ["student"],
            "email": "gob.bluth@example.com",
            "phone": "12345556789",
            "locale": "en",
            "time_zone": "America/Los_Angeles",
            "graduation_year": 1996,
            "grade_levels": ["PS"],
            "demographics": {
                "birthday": null,
                "gender": "male",
                "residence_status": null,
                "english_language_learner": null,
                "country_of_birth": "US",
                "state_of_birth": null,
                "city_of_birth": null,
                "hispanic_or_latino_ethnicity": null,
                "races": ["white"],
                "homeless": false,
                "disability": null,
                "gifted_talented": null,
                "food_service_program_eligibility": null,
                "economically_disadvantaged": null,
                "migrant": null,
                "public_assistance": null,
                "rural_residency": null,
                "individualized_education_plan": null,
                "primary_language": null,
                "special_accommodations": null,
                "military_connected": null
            },
            "address": {
                "street": "23155 Dolorosa Street",
                "unit": "Model Unit",
                "postal_code": "91365",
                "city": "Woodland Hills",
                "state": "CA",
                "country": "US"
            },
            "properties": {},
            "district_id": "792021d3-e334-4c17-b3ab-4f378b7a38ff",
            "school_ids": ["2a745e56-5137-4d13-8b48-23a5d9ae010f"],
            "product_ids": ["6c3618cb-6f1e-4c29-9b17-bed26de68729", "9db1de04-686b-4b59-b8ce-15bfcb757c60", "de8f4e41-c64c-4fe8-bcba-d74e1351d6d5"],
            "identifiers": [
                {
                    "type": "sis_id",
                    "value": "333"
                },
                {
                    "type": "school_id",
                    "value": "9090"
                }
            ]
        }
    ],
    "$request": "00000000-0000-0000-0000-000000000000"
}