getSchoolsR

get/2/schools

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/schools
  • Auth: none declared

Query parameters

district.idinteger
district.namestring
school.activeboolean
school.administrativeAreastring
school.citystring
school.countryCodestring
school.crmAccountNumberinteger
school.crmIdstring
school.idinteger
school.namestring
school.postalCodestring
school.renaissanceSchoolClient.clientIdstring

Response

OK

activeboolean required
active-idp'clever' | 'csv' | 'class-link' | 'class-link-raw' | 'renaissance' nullable
administrative-areastring nullable
citystring required
class-link-school-idstring nullable
clever-school-idstring nullable
country-codestring required
course-subjects-by-licensingboolean required
created-atstring date-time required

UTCTime

crm-account-numberinteger nullable
crm-idstring nullable
district-idinteger required
district-namestring required
formatted-address-linesstring[] nullable
idinteger required
identity-provider'clever' | 'csv' | 'class-link' | 'class-link-raw' | 'renaissance' nullable
idp-managedboolean required
latitudenumber nullable
license-utilization-notifications-muted-atstring date-time nullable

UTCTime

longitudenumber nullable
namestring required
nces-school-idstring nullable
postal-codestring nullable
renaissance-r-p-identifierstring nullable
sis-idstring nullable
sync-idpboolean required
updated-atstring date-time required

UTCTime

Changes

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