What's New in API v3.1

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.

Data Model Changes

New fields

Field Name	Description	Possible Values
roles.student.gifted_status	From CEDS element 000122: An indication that the student is participating in and served by a Gifted/Talented program	["Y", "N", ""]
roles.student.section_504_status	From CEDS element 000249: Individuals with disabilities who are being provided with related aids and services under Section 504 of the Rehabilitation Act of 1973, as amended	["Y", "N", ""]
roles.student.disability.disability_status	From CEDS element 000577: An indication of whether a person is classified as disabled under the American's with Disability Act (ADA)	["Y", "N", ""]
roles.student.disability.disability_type	From CEDS element 000218: The major or overriding disability condition that best describes a person's impairment	["Autism", "Deaf-blindness", "Developmental delay", "Emotional disturbance", "Hearing impairment", "Intellectual Disability", "Multiple disabilities", "Orthopedic impairment", "Other health impairment", "Specific learning disability", "Speech or language impairment", "Traumatic brain injury", "Visual impairment", ""]
roles.student.disability.disability_code	Primary disability type code	["AUT", "DB", "DD", "EMN", "HI", "ID", "MD", "OI", "OHI", "SLD", "SLI", "TBI", "VI", ""]

Home Language

The Home Language field will now be aligned with the ISO 639-3 standard, containing a subset of the total languages available in that standard. The language name will be provided in the existing "home_language" field, while a new "home_lanuage_code" field will contain the three-letter language code.

The Home Language values and codes supported in API v3.1 are:

roles.student.home_language values	roles.student.home_language_code values
English Afrikaans Albanian Amharic Arabic Armenian Azerbaijani Basque Belarusian Bengali Bosnian Bulgarian Burmese Cabo Verdean Cantonese Catalan Cebuano Chichewa Chinese Corsican Croatian Czech Danish Dari Dutch Estonian Farsi Filipino Finnish French Frisian Galician Georgian German Greek Gujarati Haitian Creole Hausa Hawaiian Hebrew Hindi Hmong Hungarian Ilocano Icelandic Igbo Indonesian Irish Italian Japanese Javanese Kannada Karen Kazakh Khmer Kinyarwanda Korean Kurdish (Kurmanji) Kyrgyz Laotian Latvian Lithuanian Luxembourgish Macedonian Malagasy Malay Malayalam Maltese Mandarin Maori Marathi Marshallese Mongolian Nepali Norwegian Odia Oromo Pashto Polish Portuguese Punjabi Romanian Russian Samoan Scots Gaelic Serbian Sesotho Shona Sindhi Sinhala Slovak Slovenian Somali Spanish Sundanese Swahili Swedish Tagalog Tajik Tamil Tatar Telugu Thai Tigrinya Turkish Turkmen Ukrainian Urdu Uyghur Uzbek Vietnamese Welsh Xhosa Yiddish Yoruba Zulu	eng afr sqi amh ara hye aze eus bel ben bos bul mya cpp yue cat ceb nya chi cos hrv ces dan prs nld est fas fil fin fra fry glg kat deu ell guj hat hau haw heb hin hmn hun ilo isl ibo ind gle ita jpn jav kan kar kaz khm kin kor kur kir lao lav lit ltz mkd mlg msa mal mlt cmn mri mar mah mon nep nob ori orm pus pol por pan ron rus smo gla srp sot sna snd sin slk slv som spa sun swa swe tgl tgk tam tat tel tha tir tur tuk ukr urd uig uzb vie cym xho yid yor zul

roles.student.home_language values

roles.student.home_language_code values

English
Afrikaans
Albanian
Amharic
Arabic
Armenian
Azerbaijani
Basque
Belarusian
Bengali
Bosnian
Bulgarian
Burmese
Cabo Verdean
Cantonese
Catalan
Cebuano
Chichewa
Chinese
Corsican
Croatian
Czech
Danish
Dari
Dutch
Estonian
Farsi
Filipino
Finnish
French
Frisian
Galician
Georgian
German
Greek
Gujarati
Haitian Creole
Hausa
Hawaiian
Hebrew
Hindi
Hmong
Hungarian
Ilocano
Icelandic
Igbo
Indonesian
Irish
Italian
Japanese
Javanese
Kannada
Karen
Kazakh
Khmer
Kinyarwanda
Korean
Kurdish (Kurmanji)
Kyrgyz
Laotian
Latvian
Lithuanian
Luxembourgish
Macedonian
Malagasy
Malay
Malayalam
Maltese
Mandarin
Maori
Marathi
Marshallese
Mongolian
Nepali
Norwegian
Odia
Oromo
Pashto
Polish
Portuguese
Punjabi
Romanian
Russian
Samoan
Scots Gaelic
Serbian
Sesotho
Shona
Sindhi
Sinhala
Slovak
Slovenian
Somali
Spanish
Sundanese
Swahili
Swedish
Tagalog
Tajik
Tamil
Tatar
Telugu
Thai
Tigrinya
Turkish
Turkmen
Ukrainian
Urdu
Uyghur
Uzbek
Vietnamese
Welsh
Xhosa
Yiddish
Yoruba
Zulu

eng
afr
sqi
amh
ara
hye
aze
eus
bel
ben
bos
bul
mya
cpp
yue
cat
ceb
nya
chi
cos
hrv
ces
dan
prs
nld
est
fas
fil
fin
fra
fry
glg
kat
deu
ell
guj
hat
hau
haw
heb
hin
hmn
hun
ilo
isl
ibo
ind
gle
ita
jpn
jav
kan
kar
kaz
khm
kin
kor
kur
kir
lao
lav
lit
ltz
mkd
mlg
msa
mal
mlt
cmn
mri
mar
mah
mon
nep
nob
ori
orm
pus
pol
por
pan
ron
rus
smo
gla
srp
sot
sna
snd
sin
slk
slv
som
spa
sun
swa
swe
tgl
tgk
tam
tat
tel
tha
tir
tur
tuk
ukr
urd
uig
uzb
vie
cym
xho
yid
yor
zul

Additional changes

Field Name	v3.0 Values	v3.1 Values
roles.student.frl_status	["Free", "Reduced", "Paid", ""]	["Free", "Reduced", "Paid", "Other", ""]

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 here

API v3.1 Access

If you are interested in v3.1 access, please contact your application success manager or contact the Clever Partner Engineering Team at [email protected].