Returns the status of the district

Guaranteed fields

Field name

Description

Format

id

Globally unique and stable id for district created by Clever.

ObjectID

state

Possible values: ["running", "pending", "error"] Pending means there is an error that the district can fix; Error means there is an error that Clever can fix.

String

last_sync

Last successful sync of district's data - always present as long as the district has synced at least once.

Date

instant_login

Indicates whether the district supports Clever Instant Login. Truth values indicate support.

Boolean ("true" or "false")

Optional fields

Field name

Description

Format

status.error

User-facing string describing a district error state. Typically useful only for district administrators. Should not be used to programmatically determine district status.

String

sis_type

Indicates the type of SIS this district's data originates from. "sftp" is returned when district data is synced via SFTP or CSV upload. Other string values vary.

String

Language
Click Try It! to start a request and see the response here!