For Developers

List Districts

GET https://ed.link/api/v2/my/districts

Retrieve a list of Districts that the current user is associated with. There is always one and only one district for a given user. 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. This endpoint does support standard paging a filtering query parameters, but they are almost certainly not needed.

Request Parameters

This query allows for standard paging parameters.

This query allows for filtering results.

Sample Request

axios.get('https://ed.link/api/v2/my/districts', {
    headers: {
        authorization: `Bearer ${person_access_token}`
    }
});

Sample Response

{
    "$data": [
        {
            "id": "00000000-0000-0000-0000-000000000000",
            "created_date": "2021-07-13T17:45:27.205Z",
            "updated_date": "2022-01-26T22:44:36.067Z",
            "name": "Sample District",
            "locale": null,
            "address": {},
            "time_zone": null,
            "properties": {},
            "identifiers": []
        }
    ],
    "$request": "00000000-0000-0000-0000-000000000000"
}