Clever

Data API

Serves the Clever Data API

Education#openapi#education

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Serves the Clever Data API

Endpoints 44

Contacts

  • GETgetContacts/contacts?limit=0&starting_after=string&ending_before=stringReturns a list of student contacts
  • GETgetContact/contacts/:idReturns a specific student contact
  • GETgetDistrictForStudentContact/contacts/:id/districtReturns the district for a student contact
  • GETgetStudentForContact/contacts/:id/studentReturns the student for a student contact

District Admins

  • GETgetDistrictAdmins/district_admins?starting_after=string&ending_before=string&show_links=stringReturns a list of district admins
  • GETgetDistrictAdmin/district_admins/:idReturns a specific district admin

Districts

  • GETgetDistricts/districtsReturns a list of districts. In practice this will only return the one district associated with the bearer token
  • GETgetDistrict/districts/:id?include=stringReturns a specific district
  • GETgetAdminsForDistrict/districts/:id/adminsReturns the admins for a district
  • GETgetSchoolsForDistrict/districts/:id/schools?limit=0&starting_after=string&ending_before=string&where=stringReturns the schools for a district
  • GETgetSectionsForDistrict/districts/:id/sections?limit=0&starting_after=string&ending_before=string&where=stringReturns the sections for a district
  • GETgetDistrictStatus/districts/:id/statusReturns the status of the district
  • GETgetStudentsForDistrict/districts/:id/students?limit=0&starting_after=string&ending_before=string&where=stringReturns the students for a district
  • GETgetTeachersForDistrict/districts/:id/teachers?limit=0&starting_after=string&ending_before=string&where=stringReturns the teachers for a district

School Admins

  • GETgetSchoolAdmins/school_admins?limit=0&starting_after=string&ending_before=string&where=stringReturns a list of school admins
  • GETgetSchoolAdmin/school_admins/:id?include=stringReturns a specific school admin
  • GETgetSchoolsForSchoolAdmin/school_admins/:id/schools?limit=0&starting_after=string&ending_before=stringReturns the schools for a school admin

Schools

  • GETgetSchools/schools?limit=0&starting_after=string&ending_before=string&where=stringReturns a list of schools
  • GETgetSchool/schools/:idReturns a specific school
  • GETgetDistrictForSchool/schools/:id/districtReturns the district for a school
  • GETgetSectionsForSchool/schools/:id/sections?limit=0&starting_after=string&ending_before=string&where=stringReturns the sections for a school
  • GETgetStudentsForSchool/schools/:id/students?limit=0&starting_after=string&ending_before=string&where=stringReturns the students for a school
  • GETgetTeachersForSchool/schools/:id/teachers?limit=0&starting_after=string&ending_before=string&where=stringReturns the teachers for a school

Sections

  • GETgetSections/sections?limit=0&starting_after=string&ending_before=string&where=stringReturns a list of sections
  • GETgetSection/sections/:idReturns a specific section
  • GETgetDistrictForSection/sections/:id/districtReturns the district for a section
  • GETgetSchoolForSection/sections/:id/schoolReturns the school for a section
  • GETgetStudentsForSection/sections/:id/students?limit=0&starting_after=string&ending_before=stringReturns the students for a section
  • GETgetTeacherForSection/sections/:id/teacherReturns the primary teacher for a section
  • GETgetTeachersForSection/sections/:id/teachers?limit=0&starting_after=string&ending_before=stringReturns the teachers for a section

Students

  • GETgetStudents/students?limit=0&starting_after=string&ending_before=string&where=stringReturns a list of students
  • GETgetStudent/students/:id?include=stringReturns a specific student
  • GETgetContactsForStudent/students/:id/contacts?limit=0Returns the contacts for a student
  • GETgetDistrictForStudent/students/:id/districtReturns the district for a student
  • GETgetSchoolForStudent/students/:id/schoolReturns the primary school for a student
  • GETgetSectionsForStudent/students/:id/sections?limit=0&starting_after=string&ending_before=stringReturns the sections for a student
  • GETgetTeachersForStudent/students/:id/teachers?limit=0&starting_after=string&ending_before=stringReturns the teachers for a student

Teachers

  • GETgetTeachers/teachers?limit=0&starting_after=string&ending_before=string&where=stringReturns a list of teachers
  • GETgetTeacher/teachers/:id?include=stringReturns a specific teacher
  • GETgetDistrictForTeacher/teachers/:id/districtReturns the district for a teacher
  • GETgetGradeLevelsForTeacher/teachers/:id/grade_levelsReturns the grade levels for sections a teacher teaches
  • GETgetSchoolForTeacher/teachers/:id/schoolRetrieves school info for a teacher.
  • GETgetSectionsForTeacher/teachers/:id/sections?limit=0&starting_after=string&ending_before=stringReturns the sections for a teacher
  • GETgetStudentsForTeacher/teachers/:id/students?limit=0&starting_after=string&ending_before=stringReturns the students for a teacher

API details

Base URL
https://api.clever.com/v1.2
Authentication
OAuth 2.0 (authorization code flow)
Operations
44 operations on 44 pathsGET 44
Main resources
Districts 8Sections 7Students 7Teachers 7Schools 6Contacts 4School Admins 3District Admins 2
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 1.2.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Data API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Data API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “getContacts” (GET /contacts?limit=0&starting_after=string&ending_before=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Data API?

Serves the Clever Data API It is listed under Education and has 44 endpoints.

Who publishes the Data API?

It is listed from Clever's public API description (an OpenAPI document), not published by Clever on Swastik Codes. Anyone who controls clever.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Data API?

Requests go to https://api.clever.com/v1.2. Endpoint paths are added to this base URL.

How do I authenticate with the Data API?

With OAuth 2.0 (authorization code flow).

How many endpoints does the Data API have?

44 operations on 44 paths (44 GET). The largest groups are Districts, Sections, Students, Teachers.

Is forking the Data API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.