For Developers

List People

This endpoint has been formally deprecated. Read more in the Deprecating Sections document.

GET https://ed.link/api/v2/my/sections/:section\_id/people

Retrieve a list of People associated with the specified Section. The current user must be enrolled in the requested section for this call to succeed.

Request Parameters

ParameterTypeDescription
section_idstringThe UUID of the desired Section.

This query allows for standard paging parameters.

This query allows for filtering results.

Sample Request

axios.get('https://ed.link/api/v2/my/sections/00000000-0000-0000-0000-000000000000/people', {
    headers: {
        authorization: `Bearer ${integration_access_token}`
    }
});

Sample Response

{
    "$data": [
        {
            "id": "00000000-0000-0000-0000-000000000000",
            "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": {},
            "properties": {},
            "district_id": "00000000-0000-0000-0000-000000000000",
            "school_ids": ["00000000-0000-0000-0000-000000000000"]
        }
    ],
    "$request": "00000000-0000-0000-0000-000000000000"
}