For Developers
Fetch Integration
GET https://ed.link/api/v2/teams/:team_id/integrations/:integration_id
Returns a model-shaped MikroORM Integration entity with populated application, source, and gateway relations.
Requires the integrations.read system permission. District teams must be verified to access Clever/ClassLink integrations unless the caller is an Edlink admin.
This query allows for standard paging parameters.
It is best practice to use either $first or $last in conjunction with the $next value returned by the API to paginate through results.
Read More About Paging
Developer Guide
Sample Request
const response = await axios.get(
`https://ed.link/api/v2/teams/${team_id}/integrations/${integration_id}`,
{
headers: {
authorization: `Bearer ${user_session_token}`
}
}
);
Sample Response
{
"$data": {
"id": "77a69705-41a7-49cb-0fe8-ffd425f9716f",
"created_date": "2023-11-12T20:23:16.080Z",
"updated_date": "2024-09-23T18:20:59.802Z",
"state": "active",
"billing_category": "standard",
"region_id": "us-central1-a",
"application": {
"id": "035d6dd6-1569-47b2-8ed8-63435be58078",
"name": "My Learning App",
"state": "released"
},
"source": {
"id": "5d149266-95d2-42cf-8660-8b528b3bfba3",
"name": "Edlink University Canvas",
"state": "active"
}
}
}
Related Endpoints
PATCH /api/v2/teams/:team_id/integrations/:integration_id— Update integration settingsPATCH /api/v2/teams/:team_id/integrations/:integration_id/status— Change integration stateDELETE /api/v2/teams/:team_id/integrations/:integration_id— Destroy an integration
