getV3StudentsR

get/3/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/3/students
  • Auth: none declared

Query parameters

courses.idinteger
courses.id[gt]integer
courses.id[gte]integer
courses.id[in]integer[]
courses.id[lt]integer
courses.id[lte]integer
courses.id[notin]integer[]
number
OR
'K' | '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12'
number
OR
'K' | '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12'
number
OR
'K' | '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12'
number
OR
'K' | '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12'
number
OR
'K' | '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12'
'clever' | 'csv' | 'class-link' | 'class-link-raw' | 'renaissance'
OR
'none'
'clever' | 'csv' | 'class-link' | 'class-link-raw' | 'renaissance'
OR
'none'
'clever' | 'csv' | 'class-link' | 'class-link-raw' | 'renaissance'
OR
'none'
'clever' | 'csv' | 'class-link' | 'class-link-raw' | 'renaissance'
OR
'none'
'clever' | 'csv' | 'class-link' | 'class-link-raw' | 'renaissance'
OR
'none'
namestring
schools.idinteger[] required
sis-idstring
sis-id[gt]string
sis-id[gte]string
sis-id[in]string[]
sis-id[lt]string
sis-id[lte]string
sis-id[notin]string[]
'upload' | 'idp_sync' | 'manual'
OR
'none'
'upload' | 'idp_sync' | 'manual'
OR
'none'
'upload' | 'idp_sync' | 'manual'
OR
'none'
'upload' | 'idp_sync' | 'manual'
OR
'none'
'upload' | 'idp_sync' | 'manual'
OR
'none'
teachers.idinteger
teachers.id[gt]integer
teachers.id[gte]integer
teachers.id[in]integer[]
teachers.id[lt]integer
teachers.id[lte]integer
teachers.id[notin]integer[]
teachers.namestring

Response

OK

coursesCountinteger required
firstNamestring required
idinteger required
identityProvider'clever' | 'csv' | 'class-link' | 'class-link-raw' | 'renaissance' nullable
lastNamestring required
sisIdstring nullable
source'upload' | 'idp_sync' | 'manual' nullable
teacherIdsinteger[] required

Changes

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