Please note, this call is made to a v1 endpoint. There is not currently an equivalent v2 endpoint. It is OK to rely on this endpoint, we are not planning to deprecate it. The only reason there's not a v2 equavalent is that it would have been substantially similar to this one.
GET https://ed.link/api/v1/integrations
Retrieve a list of integrations between your application and a school data source. There are no special parameters available for this endpoint.
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.
You must provide your application secret key in order to access this endpoint. This authentication mechanism is a little bit different than most other requests in our API because it is not made in the "scope" of one particular integration or person. You can find your application secret on the Edlink dashboard.
Sample Request
const integrations = await axios.get('https://ed.link/api/v1/integrations', {
headers: {
authorization: `Bearer ${application_secret_key}`
}
});
Sample Response
{
"$data": [
{
"id": "77a69705-41a7-49cb-0fe8-ffd425f9716f",
"status": "active",
"district_sharing": "all",
"developer_sharing": "rules",
"district_licensing_enabled": false,
"created_date": "2023-11-12T20:23:16.080Z",
"updated_date": "2024-09-23T18:20:59.802Z",
"permissions": [
"8aa73a24-c279-4a45-9123-9cda31cc316b",
"9e1ed7ac-a871-44c4-a355-0517b4217ecb",
"fe75b1b2-2c56-4c4b-a7a1-80048da6b24f",
"1240bc10-4d5b-48c5-b967-6e7e778dcc48",
"0e9ad589-6678-482a-b740-b2ce697ff8fb",
"7d6ea160-04ad-4c9c-92d2-ce961a982d68",
"23a6316a-f42b-4d7e-8eac-432ef4f12d3a"
],
"access_token": "TaB...zzH",
"lti_consumer_key": "yzB...sa2",
"lti_shared_secret": "Xc3...1SV",
"source": {
"id": "5d149266-95d2-42cf-8660-8b528b3bfba3",
"status": "active",
"name": "Edlink University Canvas",
"created_date": "2020-02-14T17:20:06.254Z",
"updated_date": "2020-02-14T17:20:06.254Z",
"import_interval": 3600,
"log_retention_time": 604800
},
"provider": {
"id": "035d6dd6-1569-47b2-8ed8-63435be58078",
"name": "Canvas",
"icon_url": "/source/canvas.png",
"application": "canvas",
"allows_data_sync": true
},
"team": {
"id": "d078e26d-9fcc-4f2b-b19f-430891906061",
"type": "district",
"name": "Edlink University",
"alias": "edu",
"street_address": "1011 San Jacinto Blvd",
"unit_number": "Ste 303",
"city": "Austin",
"state": "TX",
"zip": "78701",
"country": "United States"
},
"entity": null
},
{
"id": "fd8e2612-1329-4d85-bb56-95dcb27d7c92",
"status": "active",
"district_sharing": "all",
"developer_sharing": "all",
"district_licensing_enabled": true,
"created_date": "2022-10-21T20:23:16.080Z",
"updated_date": "2024-06-20T18:20:59.802Z",
"permissions": [
"796d4633-c262-49d4-8e5c-b801a6a1c053",
"0a2ff39e-ca16-458f-98c4-a58a6766c356",
"b6355c7b-56bb-48a4-a5be-0712cc0f35ea",
"8aa73a24-c279-4a45-9123-9cda31cc316b",
"9e1ed7ac-a871-44c4-a355-0517b4217ecb",
"fe75b1b2-2c56-4c4b-a7a1-80048da6b24f",
"1240bc10-4d5b-48c5-b967-6e7e778dcc48",
"0e9ad589-6678-482a-b740-b2ce697ff8fb",
"7d6ea160-04ad-4c9c-92d2-ce961a982d68",
"23a6316a-f42b-4d7e-8eac-432ef4f12d3a",
"5130c012-b5d0-4baa-816b-a6c100bac6ad",
"6429ca21-f255-44fc-873a-4aa81d45f4f5",
"c3600e5f-7da5-4820-9ca9-aa4a1e9793b3",
"58176ba0-34f6-459c-a7b0-757dbdf3b3af",
"ffef1450-8a86-4e6b-a13c-a0f2c2be5a8a"
],
"access_token": "QgH...yyA",
"lti_consumer_key": "wcD...de1",
"lti_shared_secret": "Eg9...8LP",
"source": {
"id": "12feb383-7455-4a3e-8da9-0851d77779cc",
"status": "active",
"name": "Canvas Sample Source",
"created_date": "2022-09-19T20:17:23.774Z",
"updated_date": "2022-09-19T20:17:23.774Z",
"sync_interval": 86400
},
"provider": {
"id": "035d6dd6-1569-47b2-8ed8-63435be58078",
"name": "Canvas",
"icon_url": "/source/canvas.png",
"application": "canvas",
"allows_data_sync": true
},
"team": {
"id": "d1be0f47-7765-447a-95e3-1cfaedf57ce7",
"type": "district",
"name": "Sample Developer Sources",
"alias": "SampleDeveloperSources"
},
"entity": {
"id": "8c3ec9f4-01e5-4cde-8fb1-86172257fde5",
"created_date": "2022-11-16T00:08:36.128Z",
"updated_date": "2022-11-16T00:08:36.128Z",
"type": "district",
"name": "Edlink Samples",
"website": null,
"icon_url": null,
"banner_url": null,
"street_address": null,
"unit_number": null,
"city": null,
"state": null,
"zip": null,
"nces_ids": [],
"clever_ids": [],
"mdr_ids": [],
"ipeds_ids": [],
"parent": null,
"ancestry": ["8c3ec9f4-01e5-4cde-8fb1-86172257fde5"]
}
},
{ ... }
]
}