AssignmentSubmissions
Returns a paginated list of assignment submissions across all courses
Returns a paginated list of assignment submissions across all courses.
GET
https://example.thoughtindustries.com/incoming/v2/assignmentSubmissionsExample request
curl "https://example.thoughtindustries.com/incoming/v2/assignmentSubmissions" \
-H 'Authorization: Bearer YOUR_API_KEY'Parameters
| Name | Type | Required | Location | Description |
|---|---|---|---|---|
query | string | No | query | Full-text search string to filter submissions by matching content. |
page | integer | No | query | Page number to retrieve in the paginated result set. |
clientId | uuid | No | query | Filters results to submissions belonging to the specified client. |
enableAggregations | boolean | No | query | When true, includes aggregation buckets in the response for faceted filtering. |
Example response
{
"data": {
"AssignmentSubmissions": {
"pageInfo": {
"perPage": 0,
"currentPage": 0,
"total": 0,
"hasMore": true
},
"aggregations": [
{
"key": "string",
"label": "string",
"buckets": [
{
"query": "string",
"value": "string",
"label": "string",
"description": "string",
"count": 0
}
]
}
],
"assignmentSubmissions": [
{
"id": "00000000-0000-0000-0000-000000000000",
"assignment": {
"id": "00000000-0000-0000-0000-000000000000",
"title": "string",
"description": "string"
},
"courseId": "00000000-0000-0000-0000-000000000000",
"course": {
"id": "00000000-0000-0000-0000-000000000000",
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z",
"slug": "example-slug",
"status": "draft",
"title": "string",
"sessionIsTitled": true,
"sampleLesson": {
"...": "..."
},
"sampleLessonId": "00000000-0000-0000-0000-000000000000",
"sections": [
{
"...": "..."
}
],
"appearanceBlock": "00000000-0000-0000-0000-000000000000",
"appearanceHash": "string",
"paywallsBlock": "00000000-0000-0000-0000-000000000000",
"termsBlock": "00000000-0000-0000-0000-000000000000",
"confirmationBlock": "00000000-0000-0000-0000-000000000000",
"courseStartDate": "2024-01-01T00:00:00.000Z",
"courseEndDate": "2024-01-01T00:00:00.000Z",
"enrollmentStartDate": "2024-01-01T00:00:00.000Z",
"enrollmentEndDate": "2024-01-01T00:00:00.000Z",
"gracePeriodEndDate": "2024-01-01T00:00:00.000Z",
"seatsLimit": 0,
"waitlistCount": 0,
"seatsLimitMet": true,
"waitlistingEnabled": true,
"waitlistingTriggered": true,
"taxable": true,
"purchasable": true,
"taxCategory": "00000000-0000-0000-0000-000000000000",
"fulfillmentCenter": "00000000-0000-0000-0000-000000000000",
"courseGroup": {
"...": "..."
},
"syllabusTitlesEnabled": true,
"galleryEnabled": true,
"workbookEnabled": true,
"linkedWorkbookEnabled": true,
"linkedWorkbookSkipEnabled": true,
"superquizEnabled": true,
"discussionsEnabled": true,
"resourcesEnabled": true,
"meetingsOverviewEnabled": true,
"recurrenceRule": "string",
"recurrence": {},
"readableRecurrenceString": "string",
"instructorAccessEnabled": true,
"instructorEmails": [
"string"
],
"freeWithRegistration": true,
"priceInCents": 0,
"instructorAccessPriceInCents": 0,
"suggestedRetailPriceInCents": 0,
"alternativePricingType": "membership",
"alternativePricingRef": 0,
"accessDays": 0,
"showProgress": true,
"annotationsEnabled": true,
"forceLinearProgress": true,
"completionTimePerPage": 0,
"askLearnerPassword": true,
"roster": true,
"topicGroupId": "00000000-0000-0000-0000-000000000000",
"sku": "string",
"prerequisiteCourses": [
{
"...": "..."
}
],
"prerequisiteLearningPaths": [
{
"...": "..."
}
],
"parentCourseId": "00000000-0000-0000-0000-000000000000",
"isChild": true,
"hasMultipleCurrencies": true,
"prices": [
{
"...": "..."
}
],
"enrollmentActive": true,
"waitlistActive": true,
"webinarDates": [
{
"...": "..."
}
],
"webinarTimeZone": "string",
"meetings": [
{
"...": "..."
}
],
"inPersonEventInfo": {
"...": "..."
},
"currentUserHasAccess": true,
"location": {
"...": "..."
},
"displayMap": true,
"publishDate": "2024-01-01T00:00:00.000Z",
"isActive": true,
"futurePublishDate": "2024-01-01T00:00:00.000Z",
"balanceRequirement": 0,
"awardClaimingOptions": [
{
"...": "..."
}
],
"availabilityStatus": "string",
"embeddedEnabled": true,
"displayResults": true,
"bulkPurchasingEnabled": true,
"seatTiers": [
{
"...": "..."
}
],
"seatPackages": [
{
"...": "..."
}
],
"lastTierPriceInCents": 0,
"webinarId": "string",
"hasChildren": true,
"customFields": {},
"kind": "microCourse",
"rosterSubmittedDate": "2024-01-01T00:00:00.000Z",
"finalAssessment": "string",
"scormCollectUserDetails": true,
"seatsUsedCount": 0,
"seatsAllocatedCount": 0,
"webinarDetails": {
"...": "..."
},
"showSyllabusWhileUnenrolled": true,
"topicGroup": {
"...": "..."
},
"courseGroupTitle": "string",
"currentUserDueDate": "2024-01-01T00:00:00.000Z"
},
"user": {
"id": "00000000-0000-0000-0000-000000000000",
"email": "string",
"firstName": "string",
"abbreviatedName": "string",
"asset": "string",
"lastName": "string",
"name": "string",
"lastActiveAt": "2024-01-01T00:00:00.000Z",
"bio": "string",
"twoFactorEnabled": true,
"firstInitial": "string",
"lastInitial": "string",
"invitedByName": "string",
"shouldHighlight": true,
"purchasedCourses": [
{
"...": "..."
}
],
"purchasedBundles": [
{
"...": "..."
}
],
"activeLicense": {
"...": "..."
},
"allocatedLicenses": [
{
"...": "..."
}
],
"allocatedLearningPaths": [
{
"...": "..."
}
],
"attendedMeetings": [
{
"...": "..."
}
],
"waitlistedCourses": [
{
"...": "..."
}
],
"adminClients": [
{
"...": "..."
}
],
"roleKey": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"country": "string",
"telephone": "string",
"stripeCustomerId": "00000000-0000-0000-0000-000000000000",
"externalCustomerId": "00000000-0000-0000-0000-000000000000",
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z",
"sfAccountId": "00000000-0000-0000-0000-000000000000",
"sfContactId": "00000000-0000-0000-0000-000000000000",
"shippingName": "string",
"client": {
"...": "..."
},
"clientId": "00000000-0000-0000-0000-000000000000",
"ref1": "string",
"ref2": "string",
"ref3": "string",
"ref4": "string",
"ref5": "string",
"ref6": "string",
"ref7": "string",
"ref8": "string",
"ref9": "string",
"ref10": "string",
"lang": "string",
"preferredCurrency": "string",
"customFields": {},
"recommendedTags": [
{
"...": "..."
}
],
"recommendedSlugs": [
{
"...": "..."
}
],
"accessedFlows": [
"string"
],
"disabled": true,
"learnerUserId": "00000000-0000-0000-0000-000000000000",
"managerUserId": "00000000-0000-0000-0000-000000000000",
"balance": 0,
"mustVerifyEmail": true,
"certificatesCount": 0,
"collaborationsCount": 0,
"availableCoursesCount": 0,
"startedCoursesCount": 0,
"completedCoursesCount": 0
},
"asset": "https://example.com/path",
"additionalAsset": "https://example.com/path",
"videoAsset": "string",
"body": "string",
"commentsCount": 0,
"numericGrade": 0,
"grade": "completed",
"gradeFeedback": "string",
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z",
"quizAttempt": {
"id": "00000000-0000-0000-0000-000000000000",
"assessment": {
"...": "..."
},
"answers": [
{
"...": "..."
}
],
"course": {
"...": "..."
},
"courseId": "00000000-0000-0000-0000-000000000000",
"user": {
"...": "..."
},
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z",
"timeElapsedInSeconds": 0,
"status": "started",
"grade": 0,
"originalGrade": 0,
"passed": true,
"assignmentSubmissionId": "00000000-0000-0000-0000-000000000000",
"questions": [
{
"...": "..."
}
],
"topicType": "ad",
"forgiven": true,
"topic": {
"...": "..."
},
"topicId": "00000000-0000-0000-0000-000000000000",
"questionsCount": 0,
"correctQuestionsCount": 0,
"answeredQuestionsCount": 0,
"unansweredQuestionsCount": 0,
"questionsWithChoicesCount": 0,
"poolLabelByQuestionId": {},
"linkedWorkbook": "00000000-0000-0000-0000-000000000000",
"adminUpdatedGrade": true,
"securityToken": "string"
},
"adminUpdatedGrade": true,
"license": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"label": "string",
"sku": "string",
"client": {
"...": "..."
},
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z",
"accessDays": 0,
"expirationDate": "2024-01-01T00:00:00.000Z",
"seatsLimit": 0,
"dashboardLayoutId": "00000000-0000-0000-0000-000000000000",
"enableBranding": true,
"schoolName": "string",
"isDefault": true,
"learningPaths": [
{
"...": "..."
}
],
"learningPathIds": [
"00000000-0000-0000-0000-000000000000"
],
"appearance": {
"...": "..."
},
"courses": [
{
"...": "..."
}
],
"courseIds": [
"00000000-0000-0000-0000-000000000000"
],
"courseTags": [
{
"...": "..."
}
],
"courseTagIds": [
"00000000-0000-0000-0000-000000000000"
],
"parentLicense": {
"...": "..."
},
"parentLicenseId": "00000000-0000-0000-0000-000000000000",
"childLicenses": [
{
"...": "..."
}
],
"ref1": "string",
"ref2