For Developers

List Licenses

GET https://ed.link/api/v2/graph/licenses

Retrieve a list of all Licenses assigned to this integration.

Request Parameters

This query allows for standard paging parameters.

ParameterLocationTypeDescription
$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/graph/licenses', {
    headers: {
        authorization: `Bearer ${integration_access_token}`
    }
});

Sample Response

{
    "$data": [
        {
            "id": "eb023cdc-f69e-40ff-aeb6-b2e25b42ac4a",
            "product_id": "430171b5-8fd5-4bed-8bc1-d8a580f93d74",
            "integration_id": "2212144d-2ec7-46a1-84a0-355fca213e1d",
            "school_count": 0,
            "class_count": 4,
            "person_count": 12
        },
        {
            "id": "b14cd60c-def6-4069-925b-35839ee7b645",
            "product_id": "1f2bf544-1fc3-4008-bcb8-2286b55ff116",
            "integration_id": "2212144d-2ec7-46a1-84a0-355fca213e1d",
            "school_count": 2,
            "class_count": 0,
            "person_count": 0
        },
        {
            "id": "3ba901d7-1ecf-4b41-99df-990d0f3e406c",
            "product_id": "f6e072ee-1e17-4eaa-b3b8-cdcddab8a2a3",
            "integration_id": "2212144d-2ec7-46a1-84a0-355fca213e1d",
            "school_count": 0,
            "class_count": 16,
            "person_count": 55
        }
    ],
    "$request": "00000000-0000-0000-0000-000000000000"
}