Progress API: Gradebooks

Retrieves one specific gradebook

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

gradebookstring · uuidRequired

Responses

200

OK

application/jsontext/json

achievementIdstring · uuid · nullableOptional

eventIdstring · uuid · nullableOptional

frameworkIdstring · uuid · nullableOptional

gradebookIdstring · uuidOptional

organizationIdstring · 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

get

/api/progress/gradebooks/{gradebook}

HTTPcURLJavaScriptPython

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

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",
  "organizationId": "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-03-13T14:37:51.473Z",
  "lastChangeTime": "2026-03-13T14:37:51.473Z",
  "achievementTitle": "text",
  "classInstructors": "text",
  "classScheduledStartDate": "text",
  "classScheduledEndDate": "text",
  "classTitle": "text"
}

Checks for the existence of one specific gradebook

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

gradebookstring · uuidRequired

Responses

200

OK

application/jsontext/json

booleanOptional

head

/api/progress/gradebooks/{gradebook}

HTTPcURLJavaScriptPython

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

200

OK

true

Collects the list of gradebooks that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

achievementIdstring · uuid · nullableOptional

classIdstring · uuid · nullableOptional

classInstructorIdstring · uuid · nullableOptional

frameworkIdstring · uuid · nullableOptional

organizationIdstring · 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

organizationIdstring · 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/progress/gradebooks/collect

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T14:37:51.473Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "achievementId": "123e4567-e89b-12d3-a456-426614174000",
  "classId": "123e4567-e89b-12d3-a456-426614174000",
  "classInstructorId": "123e4567-e89b-12d3-a456-426614174000",
  "frameworkId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "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-03-13T14:37:51.473Z",
  "classStartedBefore": "2026-03-13T14:37:51.473Z",
  "gradebookCreatedSince": "2026-03-13T14:37:51.473Z",
  "gradebookCreatedBefore": "2026-03-13T14:37:51.473Z",
  "lastChangeSince": "2026-03-13T14:37:51.473Z",
  "lastChangeBefore": "2026-03-13T14:37:51.473Z"
}

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",
    "organizationId": "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-03-13T14:37:51.473Z",
    "lastChangeTime": "2026-03-13T14:37:51.473Z",
    "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

identifierstring · uuid · nullableOptional

achievementIdstring · uuid · nullableOptional

classIdstring · uuid · nullableOptional

classInstructorIdstring · uuid · nullableOptional

frameworkIdstring · uuid · nullableOptional

organizationIdstring · 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/progress/gradebooks/count

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T14:37:51.473Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "achievementId": "123e4567-e89b-12d3-a456-426614174000",
  "classId": "123e4567-e89b-12d3-a456-426614174000",
  "classInstructorId": "123e4567-e89b-12d3-a456-426614174000",
  "frameworkId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "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-03-13T14:37:51.473Z",
  "classStartedBefore": "2026-03-13T14:37:51.473Z",
  "gradebookCreatedSince": "2026-03-13T14:37:51.473Z",
  "gradebookCreatedBefore": "2026-03-13T14:37:51.473Z",
  "lastChangeSince": "2026-03-13T14:37:51.473Z",
  "lastChangeBefore": "2026-03-13T14:37:51.473Z"
}

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

identifierstring · uuid · nullableOptional

achievementIdstring · uuid · nullableOptional

classIdstring · uuid · nullableOptional

classInstructorIdstring · uuid · nullableOptional

frameworkIdstring · uuid · nullableOptional

organizationIdstring · 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/progress/gradebooks/download

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T14:37:51.473Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "achievementId": "123e4567-e89b-12d3-a456-426614174000",
  "classId": "123e4567-e89b-12d3-a456-426614174000",
  "classInstructorId": "123e4567-e89b-12d3-a456-426614174000",
  "frameworkId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "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-03-13T14:37:51.473Z",
  "classStartedBefore": "2026-03-13T14:37:51.473Z",
  "gradebookCreatedSince": "2026-03-13T14:37:51.473Z",
  "gradebookCreatedBefore": "2026-03-13T14:37:51.473Z",
  "lastChangeSince": "2026-03-13T14:37:51.473Z",
  "lastChangeBefore": "2026-03-13T14:37:51.473Z"
}

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

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

gradebookTitlestring · nullableOptional

gradebookCreatedSincestring · date-time · nullableOptional

gradebookCreatedBeforestring · date-time · nullableOptional

periodIdstring · uuid · nullableOptional

achievementIdstring · uuid · nullableOptional

frameworkIdstring · uuid · nullableOptional

isLockedboolean · nullableOptional

classTitlestring · nullableOptional

classStartedSincestring · date-time · nullableOptional

classStartedBeforestring · date-time · nullableOptional

classInstructorIdstring · uuid · nullableOptional

classIdstring · uuid · nullableOptional

gradebookTypestring · nullableOptional

lastChangeTypestring · nullableOptional

lastChangeUserstring · nullableOptional

referencestring · 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/progress/gradebooks/search

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T14:37:51.473Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "gradebookTitle": "text",
  "gradebookCreatedSince": "2026-03-13T14:37:51.473Z",
  "gradebookCreatedBefore": "2026-03-13T14:37:51.473Z",
  "periodId": "123e4567-e89b-12d3-a456-426614174000",
  "achievementId": "123e4567-e89b-12d3-a456-426614174000",
  "frameworkId": "123e4567-e89b-12d3-a456-426614174000",
  "isLocked": true,
  "classTitle": "text",
  "classStartedSince": "2026-03-13T14:37:51.473Z",
  "classStartedBefore": "2026-03-13T14:37:51.473Z",
  "classInstructorId": "123e4567-e89b-12d3-a456-426614174000",
  "classId": "123e4567-e89b-12d3-a456-426614174000",
  "gradebookType": "text",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "reference": "text",
  "lastChangeSince": "2026-03-13T14:37:51.473Z",
  "lastChangeBefore": "2026-03-13T14:37:51.473Z"
}

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

200

OK

[
  {
    "gradebookId": "123e4567-e89b-12d3-a456-426614174000",
    "gradebookTitle": "text",
    "gradebookCreated": "2026-03-13T14:37:51.473Z",
    "gradebookEnrollmentCount": 1,
    "classId": "123e4567-e89b-12d3-a456-426614174000",
    "classTitle": "text",
    "classStarted": "2026-03-13T14:37:51.473Z",
    "classEnded": "2026-03-13T14:37:51.473Z",
    "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/progress/gradebooks/export

HTTPcURLJavaScriptPython

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

200

OK

{
  "downloadUrl": "text",
  "exportFormat": "text",
  "exportKey": "text",
  "expiry": "2026-03-13T14:37:51.473Z"
}

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

keystringRequired

Responses

200

OK

No content

get

/api/progress/gradebooks/exports/{key}

HTTPcURLJavaScriptPython

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

200

OK

No content