For Developers

List Districts

GET https://ed.link/api/v2/graph/people/:person_id/districts

Retrieve a list of Districts associated with the specified Person. There will always be exactly one district; we just refer to this as a "list" because you are receiving an array of one district, rather than the district object directly as you would in the equivalent "fetch" method.

Request Parameters

ParameterTypeDescription
person_idstringThe UUID of the desired Person.

This query allows for standard paging parameters.

This query allows for filtering results.

Sample Request

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

Sample Response

{
    "$data": [
        {
            "id": "00000000-0000-0000-0000-000000000000",
            "created_date": "2021-07-05T20:32:40.454Z",
            "updated_date": "2021-07-12T21:44:23.126Z",
            "name": "Gravity Falls School District",
            "locale": "en",
            "time_zone": "America/Los_Angeles",
            "location": {},
            "properties": {}
        }
    ],
    "$request": "00000000-0000-0000-0000-000000000000"
}