List Sessions

By the Edlink Team

Unknown Date

GET https://ed.link/api/v2/graph/schools/:school_id/sessions

Retrieve a list of Sessions associated with the specified School.

Request Parameters

This query allows for standard paging parameters.

Parameter	Location	Type	Description
`school_id`	`url`	`string`	The UUID of the desired School.
`$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.

Sample Request

axios.get('https://ed.link/api/v2/graph/schools/00000000-0000-0000-0000-000000000000/sessions', {
    headers: {
        authorization: `Bearer ${integration_access_token}`
    }
});

Sample Response

{
    "$data": [
        {
            "id": "00000000-0000-0000-0000-000000000000",
            "created_date": "2021-07-13T17:45:27.548Z",
            "updated_date": "2021-07-13T17:45:27.548Z",
            "name": "Fall 2021",
            "start_date": "2021-07-01T00:00:00.000Z",
            "end_date": "2022-01-01T00:00:00.000Z",
            "state": "active",
            "type": "semester",
            "properties": {},
            "school_id": "00000000-0000-0000-0000-000000000000",
            "district_id": "00000000-0000-0000-0000-000000000000"
        }
    ],
    "$request": "00000000-0000-0000-0000-000000000000"
}

Supported Providers

Schoology and Canvas do not support this endpoint since their equivalent concept of Sessions is not scoped to a particular school. In these cases, use our full List Sessions endpoint.