Progress: Gradebooks
get
Authorizations
Path parameters
gradebookstring · uuidRequired
Responses
200
OK
application/json
get
GET /v2/E01/progress/gradebooks/{gradebook} HTTP/1.1
Host:
Bearer: YOUR_API_KEY
Accept: */*
200
OK
{
"AchievementIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"EventIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"FrameworkIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"GradebookIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"PeriodIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"IsLocked": true,
"GradebookTitle": "text",
"GradebookType": "text",
"LastChangeType": "text",
"LastChangeUser": "text",
"Reference": "text",
"GradebookCreated": "2025-08-29T22:13:23.836Z",
"LastChangeTime": "2025-08-29T22:13:23.836Z"
}
head
Authorizations
Path parameters
gradebookstring · uuidRequired
Responses
200
OK
application/json
Responseboolean
head
HEAD /v2/E01/progress/gradebooks/{gradebook} HTTP/1.1
Host:
Bearer: YOUR_API_KEY
Accept: */*
200
OK
true
get
Authorizations
Query parameters
AchievementIdentifierstring · uuidOptional
ClassIdentifierstring · uuidOptional
ClassInstructorIdentifierstring · uuidOptional
FrameworkIdentifierstring · uuidOptional
OrganizationIdentifierstring · uuidOptional
PeriodIdentifierstring · 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/json
get
GET /v2/E01/progress/gradebooks/count HTTP/1.1
Host:
Bearer: YOUR_API_KEY
Accept: */*
200
OK
{
"Count": 1
}
post
Authorizations
Body
Identifierstring · uuid | nullableOptional
AchievementIdentifierstring · uuid | nullableOptional
ClassIdentifierstring · uuid | nullableOptional
ClassInstructorIdentifierstring · uuid | nullableOptional
FrameworkIdentifierstring · uuid | nullableOptional
OrganizationIdentifierstring · uuidOptional
PeriodIdentifierstring · 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/json
post
POST /v2/E01/progress/gradebooks/count HTTP/1.1
Host:
Bearer: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1249
{
"Identifier": "123e4567-e89b-12d3-a456-426614174000",
"Origin": {
"When": "2025-08-29T22:13:23.836Z",
"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"
},
"AchievementIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"ClassIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"ClassInstructorIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"FrameworkIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"PeriodIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"IsLocked": true,
"ClassTitle": "text",
"GradebookTitle": "text",
"GradebookType": "text",
"LastChangeType": "text",
"LastChangeUser": "text",
"Reference": "text",
"ClassStartedSince": "2025-08-29T22:13:23.836Z",
"ClassStartedBefore": "2025-08-29T22:13:23.836Z",
"GradebookCreatedSince": "2025-08-29T22:13:23.836Z",
"GradebookCreatedBefore": "2025-08-29T22:13:23.836Z",
"LastChangeSince": "2025-08-29T22:13:23.836Z",
"LastChangeBefore": "2025-08-29T22:13:23.836Z"
}
200
OK
{
"Count": 1
}
get
Authorizations
Query parameters
AchievementIdentifierstring · uuidOptional
ClassIdentifierstring · uuidOptional
ClassInstructorIdentifierstring · uuidOptional
FrameworkIdentifierstring · uuidOptional
OrganizationIdentifierstring · uuidOptional
PeriodIdentifierstring · 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/json
get
GET /v2/E01/progress/gradebooks HTTP/1.1
Host:
Bearer: YOUR_API_KEY
Accept: */*
200
OK
[
{
"AchievementIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"EventIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"FrameworkIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"GradebookIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"PeriodIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"IsLocked": true,
"GradebookTitle": "text",
"GradebookType": "text",
"LastChangeType": "text",
"LastChangeUser": "text",
"Reference": "text",
"GradebookCreated": "2025-08-29T22:13:23.836Z",
"LastChangeTime": "2025-08-29T22:13:23.836Z"
}
]
post
Authorizations
Body
Identifierstring · uuid | nullableOptional
AchievementIdentifierstring · uuid | nullableOptional
ClassIdentifierstring · uuid | nullableOptional
ClassInstructorIdentifierstring · uuid | nullableOptional
FrameworkIdentifierstring · uuid | nullableOptional
OrganizationIdentifierstring · uuidOptional
PeriodIdentifierstring · 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/json
post
POST /v2/E01/progress/gradebooks/collect HTTP/1.1
Host:
Bearer: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1249
{
"Identifier": "123e4567-e89b-12d3-a456-426614174000",
"Origin": {
"When": "2025-08-29T22:13:23.836Z",
"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"
},
"AchievementIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"ClassIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"ClassInstructorIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"FrameworkIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"PeriodIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"IsLocked": true,
"ClassTitle": "text",
"GradebookTitle": "text",
"GradebookType": "text",
"LastChangeType": "text",
"LastChangeUser": "text",
"Reference": "text",
"ClassStartedSince": "2025-08-29T22:13:23.836Z",
"ClassStartedBefore": "2025-08-29T22:13:23.836Z",
"GradebookCreatedSince": "2025-08-29T22:13:23.836Z",
"GradebookCreatedBefore": "2025-08-29T22:13:23.836Z",
"LastChangeSince": "2025-08-29T22:13:23.836Z",
"LastChangeBefore": "2025-08-29T22:13:23.836Z"
}
200
OK
[
{
"AchievementIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"EventIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"FrameworkIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"GradebookIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"PeriodIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"IsLocked": true,
"GradebookTitle": "text",
"GradebookType": "text",
"LastChangeType": "text",
"LastChangeUser": "text",
"Reference": "text",
"GradebookCreated": "2025-08-29T22:13:23.836Z",
"LastChangeTime": "2025-08-29T22:13:23.836Z"
}
]
get
Authorizations
Query parameters
OrganizationIdentifierstring · uuidOptional
GradebookTitlestringOptional
GradebookCreatedSincestring · date-timeOptional
GradebookCreatedBeforestring · date-timeOptional
PeriodIdentifierstring · uuidOptional
AchievementIdentifierstring · uuidOptional
FrameworkIdentifierstring · uuidOptional
IsLockedbooleanOptional
ClassTitlestringOptional
ClassStartedSincestring · date-timeOptional
ClassStartedBeforestring · date-timeOptional
ClassInstructorIdentifierstring · uuidOptional
ClassIdentifierstring · uuidOptional
GradebookTypestringOptional
LastChangeTypestringOptional
LastChangeUserstringOptional
ReferencestringOptional
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/json
get
GET /v2/E01/progress/gradebooks/search HTTP/1.1
Host:
Bearer: YOUR_API_KEY
Accept: */*
200
OK
[
{
"GradebookIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"GradebookTitle": "text",
"GradebookCreated": "2025-08-29T22:13:23.836Z",
"GradebookEnrollmentCount": 1,
"ClassIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"ClassTitle": "text",
"ClassStarted": "2025-08-29T22:13:23.836Z",
"ClassEnded": "2025-08-29T22:13:23.836Z",
"AchievementIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"AchievementTitle": "text",
"AchievementCountGranted": 1
}
]
post
Authorizations
Body
Identifierstring · uuid | nullableOptional
OrganizationIdentifierstring · uuidOptional
GradebookTitlestring | nullableOptional
GradebookCreatedSincestring · date-time | nullableOptional
GradebookCreatedBeforestring · date-time | nullableOptional
PeriodIdentifierstring · uuid | nullableOptional
AchievementIdentifierstring · uuid | nullableOptional
FrameworkIdentifierstring · uuid | nullableOptional
IsLockedboolean | nullableOptional
ClassTitlestring | nullableOptional
ClassStartedSincestring · date-time | nullableOptional
ClassStartedBeforestring · date-time | nullableOptional
ClassInstructorIdentifierstring · uuid | nullableOptional
ClassIdentifierstring · uuid | nullableOptional
GradebookTypestring | nullableOptional
LastChangeTypestring | nullableOptional
LastChangeUserstring | nullableOptional
Referencestring | nullableOptional
LastChangeSincestring · date-time | nullableOptional
LastChangeBeforestring · date-time | nullableOptional
Responses
200
OK
application/json
post
POST /v2/E01/progress/gradebooks/search HTTP/1.1
Host:
Bearer: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1249
{
"Identifier": "123e4567-e89b-12d3-a456-426614174000",
"Origin": {
"When": "2025-08-29T22:13:23.836Z",
"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"
},
"OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"GradebookTitle": "text",
"GradebookCreatedSince": "2025-08-29T22:13:23.836Z",
"GradebookCreatedBefore": "2025-08-29T22:13:23.836Z",
"PeriodIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"AchievementIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"FrameworkIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"IsLocked": true,
"ClassTitle": "text",
"ClassStartedSince": "2025-08-29T22:13:23.836Z",
"ClassStartedBefore": "2025-08-29T22:13:23.836Z",
"ClassInstructorIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"ClassIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"GradebookType": "text",
"LastChangeType": "text",
"LastChangeUser": "text",
"Reference": "text",
"LastChangeSince": "2025-08-29T22:13:23.836Z",
"LastChangeBefore": "2025-08-29T22:13:23.836Z"
}
200
OK
[
{
"GradebookIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"GradebookTitle": "text",
"GradebookCreated": "2025-08-29T22:13:23.836Z",
"GradebookEnrollmentCount": 1,
"ClassIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"ClassTitle": "text",
"ClassStarted": "2025-08-29T22:13:23.836Z",
"ClassEnded": "2025-08-29T22:13:23.836Z",
"AchievementIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"AchievementTitle": "text",
"AchievementCountGranted": 1
}
]
get
Authorizations
Query parameters
AchievementIdentifierstring · uuidOptional
ClassIdentifierstring · uuidOptional
ClassInstructorIdentifierstring · uuidOptional
FrameworkIdentifierstring · uuidOptional
OrganizationIdentifierstring · uuidOptional
PeriodIdentifierstring · 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
No content
get
GET /v2/E01/progress/gradebooks/download HTTP/1.1
Host:
Bearer: YOUR_API_KEY
Accept: */*
200
OK
No content
post
Authorizations
Body
Identifierstring · uuid | nullableOptional
AchievementIdentifierstring · uuid | nullableOptional
ClassIdentifierstring · uuid | nullableOptional
ClassInstructorIdentifierstring · uuid | nullableOptional
FrameworkIdentifierstring · uuid | nullableOptional
OrganizationIdentifierstring · uuidOptional
PeriodIdentifierstring · 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
POST /v2/E01/progress/gradebooks/download HTTP/1.1
Host:
Bearer: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1249
{
"Identifier": "123e4567-e89b-12d3-a456-426614174000",
"Origin": {
"When": "2025-08-29T22:13:23.836Z",
"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"
},
"AchievementIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"ClassIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"ClassInstructorIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"FrameworkIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"PeriodIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"IsLocked": true,
"ClassTitle": "text",
"GradebookTitle": "text",
"GradebookType": "text",
"LastChangeType": "text",
"LastChangeUser": "text",
"Reference": "text",
"ClassStartedSince": "2025-08-29T22:13:23.836Z",
"ClassStartedBefore": "2025-08-29T22:13:23.836Z",
"GradebookCreatedSince": "2025-08-29T22:13:23.836Z",
"GradebookCreatedBefore": "2025-08-29T22:13:23.836Z",
"LastChangeSince": "2025-08-29T22:13:23.836Z",
"LastChangeBefore": "2025-08-29T22:13:23.836Z"
}
200
OK
No content
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
Query parameters
AchievementIdentifierstring · uuidOptional
ClassIdentifierstring · uuidOptional
ClassInstructorIdentifierstring · uuidOptional
FrameworkIdentifierstring · uuidOptional
OrganizationIdentifierstring · uuidOptional
PeriodIdentifierstring · 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/json
get
GET /v2/E01/progress/gradebooks/export HTTP/1.1
Host:
Bearer: YOUR_API_KEY
Accept: */*
200
OK
{
"DownloadUrl": "text",
"ExportFormat": "text",
"ExportKey": "text",
"Expiry": "2025-08-29T22:13:23.836Z"
}
get
Authorizations
Path parameters
keystringRequired
Responses
200
OK
No content
get
GET /v2/E01/progress/gradebooks/exports/{key} HTTP/1.1
Host:
Bearer: YOUR_API_KEY
Accept: */*
200
OK
No content
Was this helpful?