For Developers
Preview CSV Headers
GET https://ed.link/api/v2/teams/:team_id/sources/:source_id/csv/headers
Reads uploaded CSV or SFTP files for a CSV or SFTP source and returns a preview of each file.
Permissions
Requires the sources.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. |
Sample Request
const response = await axios.get(`https://ed.link/api/v2/teams/${team_id}/sources/${source_id}/csv/headers`, {
headers: {
authorization: `Bearer ${user_session_token}`
}
});
Sample Response
{
"$data": {
"users.csv": {
"headers": ["sourcedId", "givenName", "familyName"],
"row": {
"sourcedId": "1001",
"givenName": "Ada",
"familyName": "Lovelace"
},
"rows": [
{
"sourcedId": "1001",
"givenName": "Ada",
"familyName": "Lovelace"
}
]
}
}
}
