For Developers

Fetch Onboarding

GET https://ed.link/api/v2/teams/:team_id/onboardings/:onboarding_id

Fetches detailed status, creator info, and target configuration for an onboarding invitation.

Permissions

Requires the onboardings.read system permission.

Parameters

ParameterTypeRequiredDescription
:team_idUUIDYesThe ID of the team.
:onboarding_idUUIDYesThe ID of the onboarding invitation.

Sample Request

const response = await axios.get(`https://ed.link/api/v2/teams/${team_id}/onboardings/${onboarding_id}`, {
    headers: {
        authorization: `Bearer ${user_session_token}`
    }
});

Sample Response

{
    "$data": {
        "id": "c3600e5f-7da5-4820-9ca9-aa4a1e9793b3",
        "created_date": "2026-07-01T14:00:00.000Z",
        "state": "created",
        "automatic_approval": false,
        "redirect_uri": "https://acmelearning.com/app/onboarding-complete",
        "application": {
            "id": "035d6dd6-1569-47b2-8ed8-63435be58078"
        }
    }
}