For Developers

List Source Syncs

GET https://ed.link/api/v2/teams/:team_id/sources/:source_id/syncs

Returns sync records for the source, ordered by sequence descending. Each sync is a model-shaped MikroORM Sync entity. Supports cursor pagination via $count and $after query parameters.

Requires the syncs.read system permission.

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.

Sample Request

const response = await axios.get(
    `https://ed.link/api/v2/teams/${team_id}/sources/${source_id}/syncs`,
    {
        headers: {
            authorization: `Bearer ${user_session_token}`
        },
        params: { $count: 25 }
    }
);

Sample Response

{
    "$data": [
        {
            "id": "77a69705-41a7-49cb-0fe8-ffd425f9716f",
            "created_date": "2026-08-10T06:00:00.000Z",
            "updated_date": "2026-08-10T06:45:00.000Z",
            "state": "complete",
            "type": "full",
            "source_id": "5d149266-95d2-42cf-8660-8b528b3bfba3"
        }
    ]
}
  • POST /api/v2/teams/:team_id/sources/:source_id/syncs — Queue a new sync
  • GET /api/v2/teams/:team_id/sources/:source_id/syncs/:sync_id — Fetch sync detail