Data API API

by clever.com

Overview

Serves the Clever Data API

Data API is an open data API from clever.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 44 endpoints.

At a glance

Authentication: OAuth
HTTPS: Yes
CORS: Unknown
Category: Open Data
Base URL: https://api.clever.com/v1.2
Version: 1.2.0
Endpoints: 44
OpenAPI: Specification ↗
Spec updated: 2023-03-06

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL

curl -X GET "https://api.clever.com/v1.2/contacts" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"

JavaScript

const response = await fetch("https://api.clever.com/v1.2/contacts", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "https://api.clever.com/v1.2/contacts",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
GET	`/contacts`	Returns a list of student contacts
GET	`/contacts/{id}`	Returns a specific student contact
GET	`/contacts/{id}/district`	Returns the district for a student contact
GET	`/contacts/{id}/student`	Returns the student for a student contact
GET	`/district_admins`	Returns a list of district admins
GET	`/district_admins/{id}`	Returns a specific district admin
GET	`/districts`	Returns a list of districts. In practice this will only return the one district associated with the bearer token
GET	`/districts/{id}`	Returns a specific district
GET	`/districts/{id}/admins`	Returns the admins for a district
GET	`/districts/{id}/schools`	Returns the schools for a district
GET	`/districts/{id}/sections`	Returns the sections for a district
GET	`/districts/{id}/status`	Returns the status of the district
GET	`/districts/{id}/students`	Returns the students for a district
GET	`/districts/{id}/teachers`	Returns the teachers for a district
GET	`/school_admins`	Returns a list of school admins
GET	`/school_admins/{id}`	Returns a specific school admin
GET	`/school_admins/{id}/schools`	Returns the schools for a school admin
GET	`/schools`	Returns a list of schools
GET	`/schools/{id}`	Returns a specific school
GET	`/schools/{id}/district`	Returns the district for a school
GET	`/schools/{id}/sections`	Returns the sections for a school
GET	`/schools/{id}/students`	Returns the students for a school
GET	`/schools/{id}/teachers`	Returns the teachers for a school
GET	`/sections`	Returns a list of sections
GET	`/sections/{id}`	Returns a specific section
GET	`/sections/{id}/district`	Returns the district for a section
GET	`/sections/{id}/school`	Returns the school for a section
GET	`/sections/{id}/students`	Returns the students for a section
GET	`/sections/{id}/teacher`	Returns the primary teacher for a section
GET	`/sections/{id}/teachers`	Returns the teachers for a section
GET	`/students`	Returns a list of students
GET	`/students/{id}`	Returns a specific student
GET	`/students/{id}/contacts`	Returns the contacts for a student
GET	`/students/{id}/district`	Returns the district for a student
GET	`/students/{id}/school`	Returns the primary school for a student
GET	`/students/{id}/sections`	Returns the sections for a student
GET	`/students/{id}/teachers`	Returns the teachers for a student
GET	`/teachers`	Returns a list of teachers
GET	`/teachers/{id}`	Returns a specific teacher
GET	`/teachers/{id}/district`	Returns the district for a teacher
GET	`/teachers/{id}/grade_levels`	Returns the grade levels for sections a teacher teaches
GET	`/teachers/{id}/school`	Retrieves school info for a teacher.
GET	`/teachers/{id}/sections`	Returns the sections for a teacher
GET	`/teachers/{id}/students`	Returns the students for a teacher