AssignmentSubmissions

Returns a paginated list of assignment submissions across all courses

Returns a paginated list of assignment submissions across all courses.

GEThttps://example.thoughtindustries.com/incoming/v2/assignmentSubmissions

Example 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.
`cursor`	`string`	No	query	Opaque pagination cursor returned by a previous response; use to fetch the next page of results.

Example response

{
  "pageInfo": {
    "total": 0,
    "cursor": "string",
    "hasMore": true
  },
  "assignmentSubmissions": [
    {
      "assignment": {
        "id": "00000000-0000-0000-0000-000000000000",
        "title": "string",
        "description": "string"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "courseId": "00000000-0000-0000-0000-000000000000",
      "asset": "https://example.com/path",
      "additionalAsset": "https://example.com/path",
      "body": "string",
      "numericGrade": 0,
      "grade": "string",
      "gradeFeedback": "string",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z",
      "user": {
        "id": "00000000-0000-0000-0000-000000000000",
        "email": "string",
        "firstName": "string",
        "lastName": "string",
        "ref1": "string",
        "ref2": "string",
        "ref3": "string",
        "ref4": "string",
        "ref5": "string",
        "ref6": "string",
        "ref7": "string",
        "ref8": "string",
        "ref9": "string",
        "ref10": "string"
      }
    }
  ]
}

Response fields

Field	Type	Description
`pageInfo`	`CursorPageInfo`	Pagination metadata for the current result set.
`pageInfo.total`	`integer`	Total number of submissions matching the query.
`pageInfo.cursor`	`string`	Opaque cursor to pass in the next request to retrieve the following page.
`pageInfo.hasMore`	`boolean`	Indicates whether additional pages of results are available.
`assignmentSubmissions`	`AssignmentSubmission[]`	Array of assignment submissions matching the query.
`assignmentSubmissions.assignment`	`Assignment`	The assignment this submission was made for.
`assignmentSubmissions.assignment.id`	`uuid`	Unique identifier of the assignment.
`assignmentSubmissions.assignment.title`	`string`	Title of the assignment.
`assignmentSubmissions.assignment.description`	`string`	Description of the assignment.
`assignmentSubmissions.id`	`uuid`	Unique identifier of the submission.
`assignmentSubmissions.courseId`	`uuid`	Identifier of the course the assignment belongs to.
`assignmentSubmissions.asset`	`string`	URL of the primary submitted asset.
`assignmentSubmissions.additionalAsset`	`string`	URL of an additional submitted asset, if any.
`assignmentSubmissions.body`	`string`	Text body of the submission.
`assignmentSubmissions.numericGrade`	`integer`	Numeric grade assigned to the submission.
`assignmentSubmissions.grade`	`string`	Grade status assigned to the submission.
`assignmentSubmissions.gradeFeedback`	`string`	Feedback text provided with the grade.
`assignmentSubmissions.createdAt`	`ISO 8601 timestamp`	Date and time the submission was created.
`assignmentSubmissions.updatedAt`	`ISO 8601 timestamp`	Date and time the submission was last modified.
`assignmentSubmissions.user`	`User`	User who made the submission.
`assignmentSubmissions.user.id`	`uuid`	Unique identifier of the user.
`assignmentSubmissions.user.email`	`string`	Email address of the user.
`assignmentSubmissions.user.firstName`	`string`	First name of the user.
`assignmentSubmissions.user.lastName`	`string`	Last name of the user.
`assignmentSubmissions.user.ref1`	`string`	Custom reference field 1 associated with the user.
`assignmentSubmissions.user.ref2`	`string`	Custom reference field 2 associated with the user.
`assignmentSubmissions.user.ref3`	`string`	Custom reference field 3 associated with the user.
`assignmentSubmissions.user.ref4`	`string`	Custom reference field 4 associated with the user.
`assignmentSubmissions.user.ref5`	`string`	Custom reference field 5 associated with the user.
`assignmentSubmissions.user.ref6`	`string`	Custom reference field 6 associated with the user.
`assignmentSubmissions.user.ref7`	`string`	Custom reference field 7 associated with the user.
`assignmentSubmissions.user.ref8`	`string`	Custom reference field 8 associated with the user.
`assignmentSubmissions.user.ref9`	`string`	Custom reference field 9 associated with the user.
`assignmentSubmissions.user.ref10`	`string`	Custom reference field 10 associated with the user.