GET https://ed.link/api/v2/graph/departments
Retrieve a list of all Departments.
Request Parameters
This query allows for filtering results.
This query allows for standard paging parameters.
| Parameter | Location | Type | Description |
|---|---|---|---|
$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
Sample Request
axios.get('https://ed.link/api/v2/graph/departments', {
headers: {
authorization: `Bearer ${integration_access_token}`
}
});
Sample Response
{
"$data": [
{
"id": "a43869b2-e519-4231-b9b2-bb5dedabbdb7",
"created_date": "2021-07-13T17:45:27.570Z",
"updated_date": "2021-07-13T17:45:27.570Z",
"properties": {},
"name": "Department of Mathematics",
"description": "Home of all Mathmatical and Statistical Studies",
"school_ids": ["a3303522-8747-456e-8dda-a4079dc32409"],
"identifiers": [
{
"type": "sis_id",
"value": "151"
}
]
},
{
"id": "b54969b2-e519-4231-b9b2-bb5dedabbdb8",
"created_date": "2021-07-14T10:20:30.123Z",
"updated_date": "2021-07-14T10:20:30.123Z",
"properties": {},
"name": "Department of Science",
"description": "Home of all Scientific Studies",
"school_ids": ["a3303522-8747-456e-8dda-a4079dc32409"],
"identifiers": [
{
"type": "sis_id",
"value": "152"
}
]
}
],
"$request": "00000000-0000-0000-0000-000000000000"
}