For Developers

List Sections

This endpoint has been formally deprecated. Read more in the Deprecating Sections document.

GET https://ed.link/api/v2/my/classes/:class_id/sections

Retrieve a list of Sections associated with the specified Class.

Request Parameters

This query allows for standard paging parameters.

ParameterLocationTypeDescription
class_idurlstring

The UUID of the desired Class.

$firstquerynumber

Returns the first n elements from the list.

$lastquerynumber

Returns the last n elements from the list.

$beforequeryuuid

Returns the elements in the list that come before the specified item.

$afterqueryuuid

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.

This query allows for filtering results.

Sample Request

axios.get('https://ed.link/api/v2/my/classes/c3cd44bc-2a9e-43c9-b32b-71e2b531604b/sections', {
    headers: {
        authorization: `Bearer ${person_access_token}`
    }
});

Sample Response

{
    "$data": [
        {
            "id": "947aeaaf-371a-4236-ab6d-3d41a625ebeb",
            "created_date": "2021-07-13T17:45:27.645Z",
            "updated_date": "2021-07-13T17:45:27.645Z",
            "name": "Section 3",
            "description": null,
            "picture_url": null,
            "state": "active",
            "locale": "en",
            "time_zone": "America/Chicago",
            "properties": {},
            "identifiers": [],
            "periods": ["06"],
            "period_ids": ["b5bd1ad5-6147-404a-b237-80a102b36d65"],
            "class_id": "c3cd44bc-2a9e-43c9-b32b-71e2b531604b"
        }
    ],
    "$request": "00000000-0000-0000-0000-000000000000"
}