For Developers

Onboardings Overview

An Onboarding invitation lets a developer team invite a school district to connect its LMS or SIS to a Unified API application.

Properties

PropertyTypeDescription
idUUIDUnique identifier for the onboarding invitation.
created_dateDateDate when the invitation was created.
updated_dateDateDate when the invitation was last updated.
stateStringStatus: created, started, completed, or expired.
applicationObjectApplication relation, including its id. Create requests use application_id.
automatic_approvalBooleanWhether resulting integrations are approved automatically without manual review.
redirect_uriStringPost-onboarding redirection URL for administrators.
expiration_dateDateOptional expiration timestamp after which the link becomes invalid.

JSON Example

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