Records API: Gradebooks

Retrieves one specific gradebook

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

gradebookstring · uuidRequired

Responses

404

Not Found

application/jsontext/json

get

/api/records/gradebooks/{gradebook}

HTTPcURLJavaScriptPython

GET /v2/e01/api/records/gradebooks/{gradebook} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

404

Not Found

{
  "Type": "text",
  "Title": "text",
  "Status": 1,
  "Detail": "text",
  "Instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Checks for the existence of one specific gradebook

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

gradebookstring · uuidRequired

Responses

200

OK

No content

404

Not Found

application/jsontext/json

head

/api/records/gradebooks/{gradebook}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/records/gradebooks/{gradebook} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

No content

Collects the list of gradebooks that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

AchievementIdstring · uuid · nullableOptional

ClassIdstring · uuid · nullableOptional

ClassInstructorIdstring · uuid · nullableOptional

FrameworkIdstring · uuid · nullableOptional

PeriodIdstring · uuid · nullableOptional

IsLockedboolean · nullableOptional

ClassTitlestring · nullableOptional

GradebookTitlestring · nullableOptional

GradebookTypestring · nullableOptional

LastChangeTypestring · nullableOptional

LastChangeUserstring · nullableOptional

Referencestring · nullableOptional

ClassStartedSincestring · date-time · nullableOptional

ClassStartedBeforestring · date-time · nullableOptional

GradebookCreatedSincestring · date-time · nullableOptional

GradebookCreatedBeforestring · date-time · nullableOptional

LastChangeSincestring · date-time · nullableOptional

LastChangeBeforestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

AchievementIdstring · uuid · nullableOptional

EventIdstring · uuid · nullableOptional

FrameworkIdstring · uuid · nullableOptional

GradebookIdstring · uuidOptional

PeriodIdstring · uuid · nullableOptional

IsLockedbooleanOptional

GradebookTitlestring · nullableOptional

GradebookTypestring · nullableOptional

LastChangeTypestring · nullableOptional

LastChangeUserstring · nullableOptional

Referencestring · nullableOptional

GradebookCreatedstring · date-timeOptional

LastChangeTimestring · date-timeOptional

AchievementTitlestring · nullableOptional

ClassInstructorsstring · nullableOptional

ClassScheduledStartDatestring · nullableOptional

ClassScheduledEndDatestring · nullableOptional

ClassTitlestring · nullableOptional

post

/api/records/gradebooks/collect

HTTPcURLJavaScriptPython

POST /v2/e01/api/records/gradebooks/collect HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 706

{
  "AchievementId": "123e4567-e89b-12d3-a456-426614174000",
  "ClassId": "123e4567-e89b-12d3-a456-426614174000",
  "ClassInstructorId": "123e4567-e89b-12d3-a456-426614174000",
  "FrameworkId": "123e4567-e89b-12d3-a456-426614174000",
  "PeriodId": "123e4567-e89b-12d3-a456-426614174000",
  "IsLocked": true,
  "ClassTitle": "text",
  "GradebookTitle": "text",
  "GradebookType": "text",
  "LastChangeType": "text",
  "LastChangeUser": "text",
  "Reference": "text",
  "ClassStartedSince": "2026-05-08T19:09:12.068Z",
  "ClassStartedBefore": "2026-05-08T19:09:12.068Z",
  "GradebookCreatedSince": "2026-05-08T19:09:12.068Z",
  "GradebookCreatedBefore": "2026-05-08T19:09:12.068Z",
  "LastChangeSince": "2026-05-08T19:09:12.068Z",
  "LastChangeBefore": "2026-05-08T19:09:12.068Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "AchievementId": "123e4567-e89b-12d3-a456-426614174000",
    "EventId": "123e4567-e89b-12d3-a456-426614174000",
    "FrameworkId": "123e4567-e89b-12d3-a456-426614174000",
    "GradebookId": "123e4567-e89b-12d3-a456-426614174000",
    "PeriodId": "123e4567-e89b-12d3-a456-426614174000",
    "IsLocked": true,
    "GradebookTitle": "text",
    "GradebookType": "text",
    "LastChangeType": "text",
    "LastChangeUser": "text",
    "Reference": "text",
    "GradebookCreated": "2026-05-08T19:09:12.068Z",
    "LastChangeTime": "2026-05-08T19:09:12.068Z",
    "AchievementTitle": "text",
    "ClassInstructors": "text",
    "ClassScheduledStartDate": "text",
    "ClassScheduledEndDate": "text",
    "ClassTitle": "text"
  }
]

Counts the gradebooks that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

AchievementIdstring · uuid · nullableOptional

ClassIdstring · uuid · nullableOptional

ClassInstructorIdstring · uuid · nullableOptional

FrameworkIdstring · uuid · nullableOptional

PeriodIdstring · uuid · nullableOptional

IsLockedboolean · nullableOptional

ClassTitlestring · nullableOptional

GradebookTitlestring · nullableOptional

GradebookTypestring · nullableOptional

LastChangeTypestring · nullableOptional

LastChangeUserstring · nullableOptional

Referencestring · nullableOptional

ClassStartedSincestring · date-time · nullableOptional

ClassStartedBeforestring · date-time · nullableOptional

GradebookCreatedSincestring · date-time · nullableOptional

GradebookCreatedBeforestring · date-time · nullableOptional

LastChangeSincestring · date-time · nullableOptional

LastChangeBeforestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

Countinteger · int32Optional

Summarystring · nullableOptional

post

/api/records/gradebooks/count

HTTPcURLJavaScriptPython

POST /v2/e01/api/records/gradebooks/count HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 706

{
  "AchievementId": "123e4567-e89b-12d3-a456-426614174000",
  "ClassId": "123e4567-e89b-12d3-a456-426614174000",
  "ClassInstructorId": "123e4567-e89b-12d3-a456-426614174000",
  "FrameworkId": "123e4567-e89b-12d3-a456-426614174000",
  "PeriodId": "123e4567-e89b-12d3-a456-426614174000",
  "IsLocked": true,
  "ClassTitle": "text",
  "GradebookTitle": "text",
  "GradebookType": "text",
  "LastChangeType": "text",
  "LastChangeUser": "text",
  "Reference": "text",
  "ClassStartedSince": "2026-05-08T19:09:12.068Z",
  "ClassStartedBefore": "2026-05-08T19:09:12.068Z",
  "GradebookCreatedSince": "2026-05-08T19:09:12.068Z",
  "GradebookCreatedBefore": "2026-05-08T19:09:12.068Z",
  "LastChangeSince": "2026-05-08T19:09:12.068Z",
  "LastChangeBefore": "2026-05-08T19:09:12.068Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "Count": 1,
  "Summary": "text"
}

Downloads the list of gradebooks that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

AchievementIdstring · uuid · nullableOptional

ClassIdstring · uuid · nullableOptional

ClassInstructorIdstring · uuid · nullableOptional

FrameworkIdstring · uuid · nullableOptional

PeriodIdstring · uuid · nullableOptional

IsLockedboolean · nullableOptional

ClassTitlestring · nullableOptional

GradebookTitlestring · nullableOptional

GradebookTypestring · nullableOptional

LastChangeTypestring · nullableOptional

LastChangeUserstring · nullableOptional

Referencestring · nullableOptional

ClassStartedSincestring · date-time · nullableOptional

ClassStartedBeforestring · date-time · nullableOptional

GradebookCreatedSincestring · date-time · nullableOptional

GradebookCreatedBeforestring · date-time · nullableOptional

LastChangeSincestring · date-time · nullableOptional

LastChangeBeforestring · date-time · nullableOptional

Responses

200

OK

No content

post

/api/records/gradebooks/download

HTTPcURLJavaScriptPython

POST /v2/e01/api/records/gradebooks/download HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 706

{
  "AchievementId": "123e4567-e89b-12d3-a456-426614174000",
  "ClassId": "123e4567-e89b-12d3-a456-426614174000",
  "ClassInstructorId": "123e4567-e89b-12d3-a456-426614174000",
  "FrameworkId": "123e4567-e89b-12d3-a456-426614174000",
  "PeriodId": "123e4567-e89b-12d3-a456-426614174000",
  "IsLocked": true,
  "ClassTitle": "text",
  "GradebookTitle": "text",
  "GradebookType": "text",
  "LastChangeType": "text",
  "LastChangeUser": "text",
  "Reference": "text",
  "ClassStartedSince": "2026-05-08T19:09:12.068Z",
  "ClassStartedBefore": "2026-05-08T19:09:12.068Z",
  "GradebookCreatedSince": "2026-05-08T19:09:12.068Z",
  "GradebookCreatedBefore": "2026-05-08T19:09:12.068Z",
  "LastChangeSince": "2026-05-08T19:09:12.068Z",
  "LastChangeBefore": "2026-05-08T19:09:12.068Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

Searches for the list of gradebooks that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

AchievementIdstring · uuid · nullableOptional

ClassIdstring · uuid · nullableOptional

ClassInstructorIdstring · uuid · nullableOptional

FrameworkIdstring · uuid · nullableOptional

PeriodIdstring · uuid · nullableOptional

IsLockedboolean · nullableOptional

ClassTitlestring · nullableOptional

GradebookTitlestring · nullableOptional

GradebookTypestring · nullableOptional

LastChangeTypestring · nullableOptional

LastChangeUserstring · nullableOptional

Referencestring · nullableOptional

ClassStartedSincestring · date-time · nullableOptional

ClassStartedBeforestring · date-time · nullableOptional

GradebookCreatedSincestring · date-time · nullableOptional

GradebookCreatedBeforestring · date-time · nullableOptional

LastChangeSincestring · date-time · nullableOptional

LastChangeBeforestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

GradebookIdstring · uuidOptional

GradebookTitlestring · nullableOptional

GradebookCreatedstring · date-timeOptional

GradebookEnrollmentCountinteger · int32Optional

ClassIdstring · uuid · nullableOptional

ClassTitlestring · nullableOptional

ClassStartedstring · date-time · nullableOptional

ClassEndedstring · date-time · nullableOptional

AchievementIdstring · uuid · nullableOptional

AchievementTitlestring · nullableOptional

AchievementCountGrantedinteger · int32Optional

IsLockedbooleanOptional

post

/api/records/gradebooks/search

HTTPcURLJavaScriptPython

POST /v2/e01/api/records/gradebooks/search HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 706

{
  "AchievementId": "123e4567-e89b-12d3-a456-426614174000",
  "ClassId": "123e4567-e89b-12d3-a456-426614174000",
  "ClassInstructorId": "123e4567-e89b-12d3-a456-426614174000",
  "FrameworkId": "123e4567-e89b-12d3-a456-426614174000",
  "PeriodId": "123e4567-e89b-12d3-a456-426614174000",
  "IsLocked": true,
  "ClassTitle": "text",
  "GradebookTitle": "text",
  "GradebookType": "text",
  "LastChangeType": "text",
  "LastChangeUser": "text",
  "Reference": "text",
  "ClassStartedSince": "2026-05-08T19:09:12.068Z",
  "ClassStartedBefore": "2026-05-08T19:09:12.068Z",
  "GradebookCreatedSince": "2026-05-08T19:09:12.068Z",
  "GradebookCreatedBefore": "2026-05-08T19:09:12.068Z",
  "LastChangeSince": "2026-05-08T19:09:12.068Z",
  "LastChangeBefore": "2026-05-08T19:09:12.068Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "GradebookId": "123e4567-e89b-12d3-a456-426614174000",
    "GradebookTitle": "text",
    "GradebookCreated": "2026-05-08T19:09:12.068Z",
    "GradebookEnrollmentCount": 1,
    "ClassId": "123e4567-e89b-12d3-a456-426614174000",
    "ClassTitle": "text",
    "ClassStarted": "2026-05-08T19:09:12.068Z",
    "ClassEnded": "2026-05-08T19:09:12.068Z",
    "AchievementId": "123e4567-e89b-12d3-a456-426614174000",
    "AchievementTitle": "text",
    "AchievementCountGranted": 1,
    "IsLocked": true
  }
]

get

DO NOT use allow this endpoint to be used in live Production environments. When time and budget permit, we will design and implement a fire-and-forget strategy managing a queue of large exports, reports, etc.

Authorizations

BearerCookie

BearerstringRequired

Query parameters

AchievementIdstring · uuidOptional

ClassIdstring · uuidOptional

ClassInstructorIdstring · uuidOptional

FrameworkIdstring · uuidOptional

OrganizationIdstring · uuidOptional

PeriodIdstring · uuidOptional

IsLockedbooleanOptional

ClassTitlestringOptional

GradebookTitlestringOptional

GradebookTypestringOptional

LastChangeTypestringOptional

LastChangeUserstringOptional

ReferencestringOptional

ClassStartedSincestring · date-timeOptional

ClassStartedBeforestring · date-timeOptional

GradebookCreatedSincestring · date-timeOptional

GradebookCreatedBeforestring · date-timeOptional

LastChangeSincestring · date-timeOptional

LastChangeBeforestring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/jsontext/json

DownloadUrlstring · nullableOptional

ExportFormatstring · nullableOptional

ExportKeystring · nullableOptional

Expirystring · date-timeOptional

get

/api/records/gradebooks/export

HTTPcURLJavaScriptPython

GET /v2/e01/api/records/gradebooks/export HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "DownloadUrl": "text",
  "ExportFormat": "text",
  "ExportKey": "text",
  "Expiry": "2026-05-08T19:09:12.068Z"
}

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

keystringRequired

Responses

200

OK

No content

get

/api/records/gradebooks/exports/{key}

HTTPcURLJavaScriptPython

GET /v2/e01/api/records/gradebooks/exports/{key} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

No content