getStudentsR

get/2/students

Request

  • Base URL: https://api.freckle.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.freckle.com/2/students
  • Auth: none declared

Response

OK

automatedAudio'always' | 'never' | 'default' required
classLinkStudentIdstring nullable
cleverStudentIdstring nullable
coinsSpentinteger required
coinsTodayinteger required
coinsTotalinteger required
createdAtstring date-time required

UTCTime

createdByinteger nullable
deletedAtstring date-time nullable

UTCTime

diagnosticCompletedAtstring date-time nullable

UTCTime

districtIdinteger nullable
firstNamestring required
gurIdstring nullable
idinteger required
identityProvider'clever' | 'csv' | 'class-link' | 'class-link-raw' | 'renaissance' nullable
idpManagedboolean required
isTeacherboolean required
langstring required

BCP47 language tag, such as 'en-US' or 'zh-Hant-TW'

lastNamestring required
passwordstring required
readAloudSupport'always' | 'never' | 'default' required
renaissanceManualRPIdentifierstring nullable
renaissanceRPIdentifierstring nullable
sisIdstring nullable
source'upload' | 'idp_sync' | 'manual' nullable
startingFreckleTextLevel'ER' | '1A' | '1B' | '1C' | '2A' | '2B' | '2C' | '3A' | '3B' | '3C' | '4A' | '4B' | '4C' | '5A' | '5B' | '5C' | '6A' | '6B' | '6C' | '7A' | '7B' | '7C' | '8A' | '8B' | '8C' | '9A' | '9B' | '9C' | '10A' | '10B' | '10C' | '11A' | '11B' | '11C' | '12A' | '12B' | '12C' nullable
storeLimitinteger nullable
updatedAtstring date-time required

UTCTime

wordStudyDiagnosticCompletedAtstring date-time nullable

UTCTime

wordStudyDiagnosticLevelnumber nullable

Changes

No recorded changes to this operation across all 1 revision of this API.