GET https://ed.link/api/v2/graph/periods
Retrieve a list of all Periods.
Request Parameters
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/periods', {
headers: {
authorization: `Bearer ${integration_access_token}`
}
});
Sample Response
{
"$data": [
{
"id": "ae0a50a6-390f-4d1d-a963-00e7c865f40e",
"created_date": "2022-03-25T08:30:00.000Z",
"updated_date": "2022-03-25T08:30:00.000Z",
"properties": {},
"name": "All School Assembly",
"description": "First period of the day",
"start_time": "2022-03-25T08:30:00.000Z",
"end_time": "2022-03-25T09:20:00.000Z",
"type": "assembly",
"flags": ["required"],
"school_ids": ["5c5f9063-f2f2-4d47-9ce4-eb4a4d3f3bc3"],
"session_ids": ["9a17f029-85e4-481e-b1a6-9296d3c6f1d6"]
},
{
"id": "00000000-0000-0000-0000-000000000000",
"created_date": "2021-07-05T20:32:40.454Z",
"updated_date": "2021-07-12T21:44:23.126Z",
"name": "Period 1",
"description": "Cohort 1 - Music",
"start_time": "2021-07-05T08:30:00.000Z",
"end_time": "2021-07-05T09:20:00.000Z",
"type": "class",
"flags": ["elective"],
"school_ids": ["00000000-0000-0000-0000-000000000000"],
"identifiers": [],
"properties": {}
},
{
"id": "00000000-0000-0000-0000-000000000000",
"created_date": "2021-07-05T20:32:40.454Z",
"updated_date": "2021-07-12T21:44:23.126Z",
"name": "Period 2",
"description": "Cohort 1 - English",
"start_time": "2021-07-05T08:30:00.000Z",
"end_time": "2021-07-05T09:20:00.000Z",
"type": "class",
"flags": [],
"school_ids": ["00000000-0000-0000-0000-000000000000"],
"identifiers": [],
"properties": {}
}
],
"$request": "00000000-0000-0000-0000-000000000000"
}