Skip to main content
GET
Get course by ID

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials flow. Contact timeback@trilogy.com to request credentials for your application.

Path Parameters

sourcedId
string
required

Query Parameters

fields
string

Comma-separated list of fields to include in the response. Available fields: sourcedId, status, dateLastModified, username, enabledUser, givenName, familyName, middleName, email, phone, sms, identifier, roles, grades, agents, userIds, userMasterIdentifier, preferredFirstName, preferredMiddleName, preferredLastName, primaryOrg.sourcedId, primaryOrg.type, userProfiles, userProfiles.profileId, userProfiles.profileType, userProfiles.vendorId, userProfiles.applicationId

Response

Successfully retrieved course

sourcedId
string
required

Unique identifier for the course

status
enum<string>
required

Status of an entity in the system

Available options:
active,
tobedeleted,
inactive
dateLastModified
string<date-time>
required

Timestamp of when the course was last modified

title
string
required

Title of the course

courseCode
string
required

Code used to identify the course

isUmbrella
boolean
required

True when the course is linked to two or more placement grades (i.e. spans multiple grade levels).

metadata
object | null

Additional metadata associated with the course

grades
string[] | null

Array of grade levels associated with the course

subjects
string[] | null

Array of subjects covered in the course

subjectCodes
string[] | null

Array of subject codes for the course

resources
object[]

Array of resources associated with the course

org
object | null

Organization the course belongs to

schoolYear
object | null

Academic session (school year) information