GET https://ed.link/api/v2/graph/classes/:class_id/people
Retrieve a list of People 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/graph/classes/c3cd44bc-2a9e-43c9-b32b-71e2b531604b/people', {
headers: {
authorization: `Bearer ${integration_access_token}`
}
});
Sample Response
{
"$data": [
{
"id": "63acc741-7633-453c-9bfd-75ae1ac34533",
"created_date": "2023-04-11T17:45:39.937Z",
"updated_date": "2024-05-02T17:45:39.937Z",
"first_name": "Jimithon",
"middle_name": null,
"last_name": "Teacher",
"display_name": "Teacher Jim",
"picture_url": "https://upload.wikimedia.org/wikipedia/en/thumb/2/24/Spock_Zachary_Quinto.jpg/250px-Spock_Zachary_Quinto.jpg",
"roles": ["teacher"],
"email": "jimithon.teacher@example.com",
"phone": "12345556789",
"locale": "en",
"time_zone": "America/Los_Angeles",
"graduation_year": 2011,
"grade_levels": ["05", "06", "07"],
"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": "223 Silwood Stree",
"unit": null,
"postal_code": "55467",
"city": "Nashua",
"state": "OR",
"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"
}
]
},
{
"id": "d2fd68d7-1cac-4aad-bba9-46fb83bebc52",
"created_date": "2024-03-22T17:45:39.937Z",
"updated_date": "2025-01-15T17:45:39.937Z",
"first_name": "Dorothy",
"middle_name": "Melissa",
"last_name": "Sally",
"display_name": "Sally D",
"picture_url": "https://upload.wikimedia.org/wikipedia/en/8/8e/Patrick_Steward_as_Jean-Luc_Picard_in_1996%27s_Star_Trek_First_Contact.jpg",
"roles": ["student"],
"email": "sally.d@example.com",
"phone": null,
"locale": "en",
"time_zone": "America/Los_Angeles",
"graduation_year": 2033,
"grade_levels": ["05"],
"demographics": {
"birthday": null,
"gender": "female",
"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": ["american-indian-or-alaska-native"],
"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": "11314 Prelude Ln",
"unit": "2",
"postal_code": "55101",
"city": "Springfield",
"state": "OR",
"country": "US"
},
"properties": {},
"district_id": "792021d3-e334-4c17-b3ab-4f378b7a38ff",
"school_ids": ["2a745e56-5137-4d13-8b48-23a5d9ae010f"],
"product_ids": ["6c3618cb-6f1e-4c29-9b17-bed26de68729"],
"identifiers": [
{
"type": "sis_id",
"value": "231"
},
{
"type": "school_id",
"value": "8977"
}
]
}
],
"$request": "00000000-0000-0000-0000-000000000000"
}