Progress: Gradebooks
get
Path parameters
gradebookstring · uuidRequired
Responses
200
OK
application/json
get
GET /v2/e01/progress/gradebooks/{gradebook} HTTP/1.1
Host:
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-07-16T19:47:31.337Z",
"LastChangeTime": "2025-07-16T19:47:31.337Z"
}
head
Path parameters
gradebookstring · uuidRequired
Responses
200
OK
application/json
Responseboolean
head
HEAD /v2/e01/progress/gradebooks/{gradebook} HTTP/1.1
Host:
Accept: */*
200
OK
true
get
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.Takeinteger · 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:
Accept: */*
200
OK
{
"Count": 1
}
get
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.Takeinteger · int32Optional
Filter.SortstringOptional
Filter.ExcludesstringOptional
Filter.IncludesstringOptional
Filter.FormatstringOptional
Pageinteger · int32Optional
Takeinteger · int32Optional
SortstringOptional
ExcludesstringOptional
IncludesstringOptional
FormatstringOptional
Responses
200
OK
application/json
get
GET /v2/e01/progress/gradebooks HTTP/1.1
Host:
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-07-16T19:47:31.337Z",
"LastChangeTime": "2025-07-16T19:47:31.337Z"
}
]
get
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.Takeinteger · int32Optional
Filter.SortstringOptional
Filter.ExcludesstringOptional
Filter.IncludesstringOptional
Filter.FormatstringOptional
Pageinteger · int32Optional
Takeinteger · int32Optional
SortstringOptional
ExcludesstringOptional
IncludesstringOptional
FormatstringOptional
Responses
200
OK
application/json
get
GET /v2/e01/progress/gradebooks/search HTTP/1.1
Host:
Accept: */*
200
OK
[
{
"GradebookIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"GradebookTitle": "text",
"GradebookCreated": "2025-07-16T19:47:31.337Z",
"GradebookEnrollmentCount": 1,
"ClassIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"ClassTitle": "text",
"ClassStarted": "2025-07-16T19:47:31.337Z",
"ClassEnded": "2025-07-16T19:47:31.337Z",
"AchievementIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"AchievementTitle": "text",
"AchievementCountGranted": 1
}
]
get
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.Takeinteger · int32Optional
Filter.SortstringOptional
Filter.ExcludesstringOptional
Filter.IncludesstringOptional
Filter.FormatstringOptional
Pageinteger · int32Optional
Takeinteger · int32Optional
SortstringOptional
ExcludesstringOptional
IncludesstringOptional
FormatstringOptional
Responses
200
OK
application/json
get
GET /v2/e01/progress/gradebooks/export HTTP/1.1
Host:
Accept: */*
200
OK
{
"DownloadUrl": "text",
"ExportFormat": "text",
"ExportKey": "text",
"Expiry": "2025-07-16T19:47:31.337Z"
}
get
Path parameters
keystringRequired
Responses
200
OK
get
GET /v2/e01/progress/gradebooks/download/{key} HTTP/1.1
Host:
Accept: */*
200
OK
No content
Was this helpful?