GET https://ed.link/api/v2/graph/calendars
Retrieve a list of all Calendars.
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/calendars', {
headers: {
authorization: `Bearer ${integration_access_token}`
}
});
Sample Response
{
"$data": [
{
"id": "00000000-0000-0000-0000-000000000000",
"created_date": "2022-04-14T10:45:27.570Z",
"updated_date": "2022-04-14T10:45:27.570Z",
"properties": {},
"name": "Attendance Calendar",
"code": "ATT-CAL",
"start_date": "2022-08-01T00:00:00.000Z",
"end_date": "2023-07-31T23:59:59.999Z",
"state": "active",
"flags": ["attendance"],
"type": "standard",
"school_ids": ["55555555-5555-5555-5555-555555555555", "66666666-6666-6666-6666-666666666666"]
},
{
"id": "11111111-1111-1111-1111-111111111111",
"created_date": "2022-04-14T10:45:27.570Z",
"updated_date": "2022-04-14T10:45:27.570Z",
"properties": {},
"name": "School Year 2025",
"code": "SCH-YR-2025",
"start_date": "2025-08-01T00:00:00.000Z",
"end_date": "2026-07-31T23:59:59.999Z",
"state": "active",
"flags": [],
"type": "standard",
"school_ids": ["55555555-5555-5555-5555-555555555555", "66666666-6666-6666-6666-666666666666"]
},
{
"id": "22222222-2222-2222-2222-222222222222",
"created_date": "2022-04-14T10:45:27.570Z",
"updated_date": "2022-04-14T10:45:27.570Z",
"properties": {},
"name": "School Year 2024",
"code": "SCH-YR-2024",
"start_date": "2024-08-01T00:00:00.000Z",
"end_date": "2025-07-31T23:59:59.999Z",
"state": "inactive",
"flags": [],
"type": "standard",
"school_ids": ["55555555-5555-5555-5555-555555555555", "66666666-6666-6666-6666-666666666666"]
}
],
"$request": "00000000-0000-0000-0000-000000000000"
}