v1

latestOpenAPI 3.0.02026-08-042710098.2 KB
reunification

Get the current reunification import status

Returns the status of the organization's most recent reunification import, including per-entity synced/total counts and the succeeded_users / failed_users provisioning figures. Poll this after starting an import. Requires read:* scope and a regular creator role.

Note: succeeded_users and failed_users are eventually consistent. Guest/staff accounts are provisioned in the background after the roster is imported, so these counts keep climbing for a few seconds after status becomes completed. Treat completed as "roster imported" and keep polling the user counts until they stop changing.

completed means the roster was imported and account provisioning was dispatched — it does not by itself mean every account succeeded. Check failed_users: a non-zero value on a completed import is a partial success (e.g. seat limits or Auth0 rejections for some users).

get/v1/reunification/imports/status

Response

Successful Response

idstring required
status'in_progress' | 'completed' | 'failed' required
synced_schoolsinteger
total_schoolsinteger
synced_studentsinteger
total_studentsinteger
synced_teachersinteger
total_teachersinteger
synced_staffinteger
total_staffinteger
synced_guardiansinteger
total_guardiansinteger
succeeded_usersinteger
failed_usersinteger
error_messagestring
started_atstring date-time
completed_atstring date-time