Sign in
reunification

Get the current reunification import status

Returns the status of your organization's most recent reunification import. Poll this after starting one. Requires read:* scope and a regular creator role.

Status is kept for one hour after its last update and then this returns 404. Store anything you need to keep.

completed means the roster was written and account provisioning was handed to a background worker, not that every account exists. succeeded_users and failed_users keep rising afterwards, which can take several minutes on a large roster, so poll until both stop moving.

The synced_* and total_* pairs are a progress bar rather than a success ratio. They end up equal whenever the roster is written, so they cannot tell you a record was rejected.

A failed status does not mean the roster is untouched. If the failure came after the roster was committed the new roster is live, and account provisioning may not have started or may already be under way.

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

Counted after the merge described on the guardian object, so it is usually lower than the number of guardian entries you sent.

succeeded_usersinteger

Coram accounts created or updated. Rises in the background after status becomes completed. Guardians are never included, because they get no account.

failed_usersinteger

Accounts that could not be created, usually a seat limit or an Auth0 rejection. Zero does not mean everyone succeeded, since anyone without a valid email is absent from both figures.

error_messagestring
started_atstring date-time

Carries a real time only while the import is in progress. Once it reaches completed or failed the field is still returned but reset to 0001-01-01T00:00:00Z, so record the start time yourself if you need it.

completed_atstring date-time

Returned as 0001-01-01T00:00:00Z until the import finishes.

Changes

No recorded changes to this endpoint across all 7 revisions of this API.