For Developers
List Syncs
GET https://ed.link/api/v2/teams/:team_id/sources/:source_id/syncs
Returns a paginated list of sync runs for the specified source, ordered by sequence descending.
Permissions
Requires the syncs.read system permission.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
:team_id | UUID | Yes | The ID of the team. |
:source_id | UUID | Yes | The ID of the source. |
$page | Number | No | Page number for pagination. |
$filter | String | No | Filter expression matching sync state or date. |
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}`
}
}
);
Sample Response
{
"$data": [
{
"id": "673cf97a-9a91-4560-8f96-3a72df54db12",
"started_date": "2024-06-21T06:01:00.000Z",
"completed_date": "2024-06-21T06:45:00.000Z",
"state": "completed",
"type": "scheduled"
}
]
}
