> For the complete documentation index, see [llms.txt](https://developerdocs.instructure.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developerdocs.instructure.com/services/canvas/resources/quiz_submission_user_list.md).

# Quiz Submission User List

List of users who have or haven't submitted for a quiz.

#### A QuizSubmissionUserList object looks like: <a href="#quizsubmissionuserlist" id="quizsubmissionuserlist"></a>

```js
{
  "meta": {
    "$ref": "QuizSubmissionUserListMeta",
    "description": "contains meta information (such as pagination) for the list of users"
  },
  "users": {
    "$ref": "User",
    "description": "list of users that match the query"
  }
}
```

#### A QuizSubmissionUserListMeta object looks like: <a href="#quizsubmissionuserlistmeta" id="quizsubmissionuserlistmeta"></a>

```js
{
  "pagination": {
    "$ref": "JSONAPIPagination",
    "description": "contains pagination information for the list of users"
  }
}
```

#### A JSONAPIPagination object looks like: <a href="#jsonapipagination" id="jsonapipagination"></a>

```js
{
  "per_page": {
    "type": "integer",
    "description": "number of results per page",
    "example": 10
  },
  "page": {
    "type": "integer",
    "description": "the current page passed as the ?page= parameter",
    "example": 1
  },
  "template": {
    "type": "string",
    "description": "URL template for building out other paged URLs for this endpoint",
    "example": "https://example.instructure.com/api/v1/courses/1/quizzes/1/submission_users?page={page}"
  },
  "page_count": {
    "type": "integer",
    "description": "number of pages for this collection",
    "example": 10
  },
  "count": {
    "type": "integer",
    "description": "total number of items in this collection",
    "example": 100
  }
}
```

## [Send a message to unsubmitted or submitted users for the quiz](#method.quizzes/quiz_submission_users.message) <a href="#method.quizzes-quiz_submission_users.message" id="method.quizzes-quiz_submission_users.message"></a>

[Quizzes::QuizSubmissionUsersController#message](https://github.com/instructure/canvas-lms/blob/master/app/controllers/quizzes/quiz_submission_users_controller.rb)

#### `POST /api/v1/courses/:course_id/quizzes/:id/submission_users/message`

**Scope:** `url:POST|/api/v1/courses/:course_id/quizzes/:id/submission_users/message`

{ "body": { "type": "string", "description": "message body of the conversation to be created", "example": "Please take the quiz." }, "recipients": { "type": "string", "description": "Who to send the message to. May be either 'submitted' or 'unsubmitted'", "example": "submitted" }, "subject": { "type": "string", "description": "Subject of the new Conversation created", "example": "ATTN: Quiz 101 Students" } }

#### Request Parameters:

| Parameter       | Type                   | Description                                   |
| --------------- | ---------------------- | --------------------------------------------- |
| `conversations` | `QuizUserConversation` | - Body and recipients to send the message to. |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developerdocs.instructure.com/services/canvas/resources/quiz_submission_user_list.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.