For Developers

Create Onboarding

POST https://ed.link/api/v2/teams/:team_id/onboardings

Creates a developer-to-school onboarding invitation for a Unified API application owned by the developer team.

Permissions

Requires the onboardings.create system permission.

Parameters

ParameterTypeRequiredDescription
:team_idUUIDYesThe ID of the team.

Request Body

PropertyTypeRequiredDescription
application_idUUIDYesThe application to integrate, owned by the developer team.
institution_idUUIDNoTarget educational institution (requires verified team).
provider_idUUIDNoPre-selected provider ID.
automatic_approvalBooleanNoWhether created integrations should be automatically approved.
expiration_dateDateNoInvitation expiry timestamp.
redirect_uriStringNoURL to redirect administrators to upon completion.

Sample Request

const response = await axios.post(
    `https://ed.link/api/v2/teams/${team_id}/onboardings`,
    {
        application_id: '035d6dd6-1569-47b2-8ed8-63435be58078',
        automatic_approval: true,
        redirect_uri: 'https://acmelearning.com/app/onboarding-complete'
    },
    {
        headers: {
            authorization: `Bearer ${user_session_token}`,
            'content-type': 'application/json'
        }
    }
);

Sample Response

{
    "$data": {
        "id": "c3600e5f-7da5-4820-9ca9-aa4a1e9793b3",
        "created_date": "2026-07-01T14:00:00.000Z",
        "state": "created",
        "automatic_approval": true,
        "application": {
            "id": "035d6dd6-1569-47b2-8ed8-63435be58078"
        }
    }
}