❗️

Clever Complete Agreement Required

This feature is included with a Clever Complete subscription. Sign up here or email your Application Success Manager to learn more.

Table of Contents

Schema
Example Courses Object
Related Objects

Schema

🚧

No user tokens

The course object cannot be accessed using a user-level token provided through SSO. To pull course information, you will need to use a district bearer token.

❗️

Fields are not returned in a specific order so please ensure that your app does not rely on the order.

Field	Guaranteed?	Description
id	Guaranteed	Globally unique and stable id for course created by Clever. Used in API calls (ex /v3.0/courses/4fe3ff51dfa547000000041f)
district	Guaranteed	Globally unique and stable id for course's district.
links.district	Guaranteed	Gets the district for a course.
links.sections	Guaranteed	Gets all sections for a course.
links.self	Guaranteed	Stable link to course.
name	Not Guaranteed	Name provided by district.
number	Not Guaranteed	Course number provided by district.

Example Courses Object

"data": {
    "id": "string", // ObjectID: Globally unique and stable ID for the course
    "district": "string", // ObjectID: Globally unique and stable ID for the course's district
    "name": "string", // String: name provided by district
    "number": "string" // String: course number provided by district
}

Related Objects

To retrieve a list of the section objects associated with a course, use /courses/{id}/sections.