LearnSprout Connect API

• Organization Methods

  • List Methods
  • Expand Methods

  • GETRetrieving a List of Organizations/org
    Returns A list of organizations you have access to.
    
    
  • GETRetrieving an Organization/org/:org_id
    Retrieving an Organization
    
    

    Parameter	Value	Type	Description
    org_id		string	LearnSprout ID of the Organization

• School Methods

  • List Methods
  • Expand Methods

  • GETRetrieving a School List/org/:org_id/school
    Returns A list of schools within that organization wrapped in a pagination object which is comprised of a data field and a pointer to the next set of data
    
    

    Parameter	Value	Type	Description
    org_id		string	LearnSprout ID for the Organization
    since		int	Filters objects that have been updated after the given Unix timestamp

  • GETRetrieving a School/org/:org_id/school/:school_id
    Retrieving a School
    
    

    Parameter	Value	Type	Description
    org_id		string	LearnSprout ID for the Organization
    school_id		string	LearnSprout ID for the School

• Student Methods

  • List Methods
  • Expand Methods

  • GETRetrieving a List of Students/org/:org_id/student
    A list of students wrapped in a pagination object which is comprised of a data field and a pointer to the next set of data.
    
    

    Parameter	Value	Type	Description
    org_id		string	LearnSprout ID of the Student
    since		Unix timestamp	Filters objects that have been updated after the given Unix timestamp

  • GETRetrieving a List of Students by School/org/:org_id/school/:school_id/student
    A list of students filtered by school wrapped in a pagination object which is comprised of a data field and a pointer to the next set of data.
    
    

    Parameter	Value	Type	Description
    org_id		string	LearnSprout ID of the Organization
    school_id		string	LearnSprout ID of the School
    since		int	Filters objects that have been updated after the given Unix timestamp

  • GETRetrieving a Student/org/:org_id/student/:student_id
    Retrieving a Student
    
    

    Parameter	Value	Type	Description
    org_id		string	LearnSprout ID of the Organization
    student_id		string	LearnSprout ID of the Student

• Section Methods

  • List Methods
  • Expand Methods

  • GETRetrieving a List of Sections/org/:org_id/section
    A list of sections wrapped in a pagination object which is comprised of a data field and a pointer to the next set of data.
    
    

    Parameter	Value	Type	Description
    org_id		string	LearnSprout ID of the Organization
    since		int	Filters objects that have been updated after the given Unix timestamp

  • GETRetrieving a List of Sections by School/org/:org_id/school/:school_id/section
    A list of sections by school wrapped in a pagination object which is comprised of a data field and a pointer to the next set of data.
    
    

    Parameter	Value	Type	Description
    org_id		string	LearnSprout ID of the Organization
    school_id		string	LearnSprout ID of the School
    since		int	Filters objects that have been updated after the given Unix timestamp

  • GETRetrieving a Section/org/:org_id/section/:section_id
    Retrieving a Section
    
    

    Parameter	Value	Type	Description
    org_id		string	LearnSprout ID of the Organization
    section_id		string	LearnSprout ID of the Section

• Teacher Methods

  • List Methods
  • Expand Methods

  • GETRetrieving a List of Teachers/org/:org_id/teacher
    A list of teachers for a given organization wrapped in a pagination object which is comprised of a data field and a pointer to the next set of data.
    
    

    Parameter	Value	Type	Description
    org_id		string	LearnSprout ID of the Organization
    since		int	Filters objects that have been updated after the given Unix timestamp

  • GETRetrieving a List of Teachers by School/org/:org_id/school/:school_id/teacher
    A list of teachers by school wrapped in a pagination object which is comprised of a data field and a pointer to the next set of data.
    
    

    Parameter	Value	Type	Description
    org_id		string	LearnSprout ID of the Organization
    school_id		string	LearnSprout ID of the School
    since		int	Filters objects that have been updated after the given Unix timestamp

  • GETRetrieving a Teacher/org/:org_id/teacher/:teacher_id
    Retrieving a Teacher
    
    

    Parameter	Value	Type	Description
    org_id		string	LearnSprout ID of the Organization
    teacher_id		string	LearnSprout ID of the Teacher

  • GETRetrieving a List of Sections by a Teacher/org/:org_id/teacher/:teacher_id/section
    Retrieving a Teacher
    
    

    Parameter	Value	Type	Description
    org_id		string	LearnSprout ID of the Organization
    teacher_id		string	LearnSprout ID of the Teacher

• Term Methods

  • List Methods
  • Expand Methods

  • GETRetrieving a List of Terms/org/:org_id/term
    A list of terms for a given organization wrapped in a pagination object which is comprised of a data field and a pointer to the next set of data.
    
    

    Parameter	Value	Type	Description
    org_id		string	LearnSprout ID of the Organization
    since		int	Filters objects that have been updated after the given Unix timestamp

  • GETRetrieving a List of Terms by School/org/:org_id/school/:school_id/term
    A list of terms by school wrapped in a pagination object which is comprised of a data field and a pointer to the next set of data.
    
    

    Parameter	Value	Type	Description
    org_id		string	LearnSprout ID of the Organization
    school_id		string	LearnSprout ID of the School
    since		int	Filters objects that have been updated after the given Unix timestamp

  • GETRetrieving a Term/org/:org_id/term/:term_id
    Retrieving a Term
    
    

    Parameter	Value	Type	Description
    org_id		string	LearnSprout ID of the Organization
    term_id		string	LearnSprout ID of the Term

  • GETRetrieving the Current Term by School/org/:org_id/school/:school_id/term/current
    The current term object
    
    

    Parameter	Value	Type	Description
    org_id		string	LearnSprout ID of the Organization
    school_id		string	LearnSprout ID of the School

• Course Methods

  • List Methods
  • Expand Methods

  • GETRetrieving a List of Courses/org/:org_id/course
    Retrieving a List of Courses
    
    

    Parameter	Value	Type	Description
    org_id		string	LearnSprout ID of the Organization
    since		int	Filters objects that have been updated after the given Unix timestamp

  • GETRetrieving a List of Courses for by School/org/:org_id/school/:school_id/course
    Retrieving a List of Courses for by School
    
    

    Parameter	Value	Type	Description
    org_id		string	LearnSprout ID of the Organization
    school_id		string	LearnSprout ID of the School
    since		int	Filters objects that have been updated after the given Unix timestamp

  • GETRetrieving a Course/org/:org_id/course/:course_id
    Retrieving a Course
    
    

    Parameter	Value	Type	Description
    org_id		string	LearnSprout ID of the Organization
    course_id		string	LearnSprout ID of the Course

• Attendance Record Methods

  • List Methods
  • Expand Methods

  • GETRetrieving a List of Attendance Records by Organization/org/:org_id/attendance
    Retrieving a List of Attendnace Records by Organization
    
    

    Parameter	Value	Type	Description
    org_id		string	LearnSprout ID of the Organization
    since		int	Filters objects that have been updated after the given Unix timestamp

  • GETRetrieving a List of Attendance Records by School/org/:org_id/school/:school_id/attendance
    Retrieving a List of Attendnace Records by School
    
    

    Parameter	Value	Type	Description
    org_id		string	LearnSprout ID of the Organization
    school_id		string	LearnSprout ID of the School
    since		int	Filters objects that have been updated after the given Unix timestamp

  • GETRetrieving a List of Attendance Records by Student/org/:org_id/student/:student_id/attendance
    Retrieving a List of Attendnace Records by Student
    
    

    Parameter	Value	Type	Description
    org_id		string	LearnSprout ID of the Organization
    student_id		string	LearnSprout ID of the Student
    since		int	Filters objects that have been updated after the given Unix timestamp

  • GETRetrieving a List of Attendance Records by Section/org/:org_id/school/:school_id/section/:section_id/attendance
    Retrieving a List of Attendnace Records by Section
    
    

    Parameter	Value	Type	Description
    org_id		string	LearnSprout ID of the Organization
    school_id		string	LearnSprout ID of the School
    section_id		string	LearnSprout ID of the Section
    since		int	Filters objects that have been updated after the given Unix timestamp

• Course Grades Methods

  • List Methods
  • Expand Methods

  • GETRetrieving a List of Grades Records by Organization/org/:org_id/course_grade
    Retrieving a List of Graes Records by Organization
    
    

    Parameter	Value	Type	Description
    org_id		string	LearnSprout ID of the Organization
    since		int	Filters objects that have been updated after the given Unix timestamp