What's New in API v3.1
Table of Contents
Overview
Data Model Changes
LMS Connect
Overview
Clever's API v3.1 adds a number of fields and values to the student user object to support better sharing of demographics data between districts and applications. API v3.1 will only contain non-breaking changes, so integrations built on API v3.0 can easily be upgraded to use the new fields.
API v3.1 adds these student demographic updates:
- new CEDS-aligned gifted, Section 504, and disability fields
- a new
roles.student.home_language_codefield aligned to a subset of ISO 639-3 language codes - an expanded
roles.student.frl_statusenum that now also supports"Other"
For the complete field list, possible values, and CEDS references, see API v3.1 Updates.
v3.1 AccessIf you are interested in v3.1 access, please contact your application success manager or contact the Clever Partner Engineering Team at [email protected].
Data Model Changes
API v3.1 adds student demographic fields and values without breaking existing v3.0 integrations.
Use API v3.1 Updates as the canonical reference for:
- CEDS descriptions for gifted, Section 504, and disability fields
- possible values for each new field
- supported
roles.student.home_languageandroles.student.home_language_codevalues - the
roles.student.frl_statusenum change
LMS Connect
With API v3.1 of the Clever API, we introduce the LMS Connect integration. This integration extends our existing rostering capabilities and supports assignment and grade passback from your application, through Clever and into a district LMS. Currently, the LMSs supported are Canvas, Schoology, and Google Classroom. However, we are always looking to expand our offerings! If you have any requests for support of a specific LMS that's not listed above, please reach out to your success manager or [email protected]. .
More on LMS Connect can be found in the LMS Connect section of these docs.
Updated 13 days ago
