For Developers

Person

My Profile

Retrieve the authenticated Person.

await edlink.use(person_token_set).my.profile();

My Integration

Retrieve the authenticated user's integration.

await edlink.use(person_token_set).my.integration();

Sample Response

{
    "state": "active",
    "id": "00000000-0000-0000-0000-000000000000",
    "created_date": "2020-02-14T17:20:06.254Z",
    "updated_date": "2020-02-14T17:20:06.254Z",
    "permissions": [],
    "scope": "all",
    "start_date": null,
    "end_date": null,
    "locked": false,
    "application_id": "00000000-0000-0000-0000-000000000000",
    "source_id": "00000000-0000-0000-0000-000000000000",
    "destination_id": null,
    "region_id": "00000000-0000-0000-0000-000000000000"
}

My Source

Retrieve the authenticated user's source.

await edlink.use(person_token_set).my.source();

Sample Response

{
    "state": "active",
    "id": "00000000-0000-0000-0000-000000000000",
    "created_date": "2020-02-14T17:20:06.254Z",
    "updated_date": "2020-02-14T17:20:06.254Z",
    "name": "Springfield School District Canvas",
    "sync_interval": 86400,
    "provider_id": "00000000-0000-0000-0000-000000000000",
    "properties": {},
    "team_id": "00000000-0000-0000-0000-000000000000",
    "provider": {
        "active": true,
        "requires_administrator_login": true,
        "requires_administrator_consent": false,
        "requires_remote_configuration": false,
        "allows_data_sync": true,
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "Canvas",
        "application": "canvas"
    }
}