For Developers

Get Calendar

GET https://ed.link/api/v2/graph/calendars/:calendar_id

Retrieve information about a specific Calendar.

Request Parameters

ParameterLocationTypeDescription
calendar_idurlstringThe UUID of the desired Calendar.

Sample Request

axios.get('https://ed.link/api/v2/graph/calendars/00000000-0000-0000-0000-000000000000', {
    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"]
    },
    "$request": "00000000-0000-0000-0000-000000000000"
}