# Reminders
Reminders are user notifications reminding them to complete an action for a given realm. The API supports viewing realm-specific reminders that mirror the functionality of the reminder widget on the web. Supported reminder types include `ungraded` (a reminder for course section admins that lists assignments and corresponding revisions that have not yet been graded) and `resubmitted` (a reminder for course section admins that lists assignments and corresponding revisions that have not yet been viewed).
:::note
Reminders exist in sections.
:::
## Fields
| Field | Name | Description | Type |
| -------------------- | ------------------ | --------------------------------------------------------------------------------------- | --------- |
| `type` | Type | Type of reminder; one of the supported reminder types: `ungraded`, `resubmitted`. | `string` |
| `count` | Count | The number of reminders. | `integer` |
| `assignments` | Assignments | List of assignment objects that have relevant revisions (see assignment fields below). | `array` |
| `id` | ID | The assignment ID. | `integer` |
| `title` | Title | Assignment title. | `string` |
| `description` | Description | Assignment description. | `string` |
| `due` | Due | Assignment due date/time (may be empty). | `string` |
| `grading_scale` | Grading scale | ID of grading scale. | `string` |
| `grading_period` | Grading period | ID of grading period. | `string` |
| `grading_category` | Grading category | ID of grading category. | `string` |
| `max_points` | Max points | Maximum points for the assignment. | `string` |
| `factor` | Factor | Grade factor. | `string` |
| `is_final` | Is final | Whether the grade is final. | `string` |
| `show_comments` | Show comments | Whether comments are shown. | `string` |
| `grade_stats` | Grade stats | Whether grade stats are shown. | `string` |
| `allow_dropbox` | Allow dropbox | Whether dropbox is allowed. | `string` |
| `allow_discussion` | Allow discussion | Whether discussion is allowed. | `string` |
| `published` | Published | Whether the assignment is published. | `integer` |
| `type` | Type | The content type (e.g., `assignment`). | `string` |
| `grade_item_id` | Grade item ID | Grade item identifier. | `integer` |
| `available` | Available | Whether assignment is available. | `integer` |
| `completed` | Completed | Whether assignment is completed. | `integer` |
| `dropbox_locked` | Dropbox locked | Whether dropbox is locked. | `integer` |
| `grading_scale_type` | Grading scale type | Grading scale type. | `integer` |
| `show_rubric` | Show rubric | Whether rubric is shown. | `boolean` |
| `num_assignees` | Num assignees | Number of assignees. | `integer` |
| `assignees` | Assignees | List of assignee objects (may be empty). | `array` |
| `section_id` | Section ID | ID of the section this assignment belongs to. | `string` |
| `revisions` | Revisions | List of student revision objects related to the assignment (see revision fields below). | `array` |
| `revision_id` | Revision ID | The revision identifier. | `integer` |
| `uid` | User ID | ID of the user who submitted the revision. | `integer` |
| `created` | Created | Unix timestamp when the revision was created. | `integer` |
| `num_items` | Num items | Number of items in the revision. | `integer` |
| `late` | Late | Whether the submission was late. | `integer` |
| `draft` | Draft | Whether the revision is a draft. | `integer` |
\* = Required
## GET `reminders/{type}`
View a list of reminders across all realms for a specific type.
Parameters: `with_attachments` — retrieve attachments for this piece of content.
**Return** A list of reminders (see Fields)
```json
{
"reminders": [
{
"type": "ungraded",
"count": 3,
"assignments": [
{
"id": 5818701,
"title": "Assignment 1",
"description": "Please use the attached document to complete the assignment",
"due": "",
"grading_scale": "0",
"grading_period": "25097",
"grading_category": "4445",
"max_points": "100",
"factor": "1",
"is_final": "0",
"show_comments": "0",
"grade_stats": "0",
"allow_dropbox": "1",
"allow_discussion": "1",
"published": 1,
"type": "assignment",
"grade_item_id": 5818701,
"available": 1,
"completed": 0,
"dropbox_locked": 0,
"grading_scale_type": 0,
"show_rubric": false,
"num_assignees": 0,
"assignees": [],
"section_id": "5818697",
"revisions": [
{
"revision_id": 8,
"uid": 248071,
"created": 1409094487,
"num_items": 1,
"late": 1,
"draft": 0
}
]
},
{
"id": 9274619,
"title": "Health Choices",
"description": "",
"due": "",
"grading_scale": "0",
"grading_period": "31217",
"grading_category": "7813",
"max_points": "100",
"factor": "1",
"is_final": "0",
"show_comments": "0",
"grade_stats": "0",
"allow_dropbox": "1",
"allow_discussion": "1",
"published": 1,
"type": "assignment",
"grade_item_id": 9274619,
"available": 1,
"completed": 0,
"dropbox_locked": 0,
"grading_scale_type": 0,
"show_rubric": false,
"num_assignees": 0,
"assignees": [],
"section_id": "8495243",
"revisions": [
{
"revision_id": 15,
"uid": 81562,
"created": 1411075065,
"num_items": 1,
"late": 0,
"draft": 0
},
{
"revision_id": 6,
"uid": 2441585,
"created": 1410805384,
"num_items": 1,
"late": 0,
"draft": 0
}
]
}
]
}
]
}
```
```xml
ungraded
3
5818701
Assignment 1
Please use the attached document to complete the assignment
0
25097
4445
100
1
0
0
0
1
1
1
assignment
5818701
1
0
0
0
0
5818697
8
248071
1409094487
1
1
0
9274619
Health Choices
0
31217
7813
100
1
0
0
0
1
1
1
assignment
9274619
1
0
0
0
0
8495243
15
81562
1411075065
1
0
0
6
2441585
1410805384
1
0
0
```
## GET `{realm}/reminders/{type}`
View a list of reminders for a specific realm for a specific type.
Parameters: `with_attachments` — retrieve attachments for this piece of content.
**Return** A list of reminders (see Fields)
```json
{
"reminders": [
{
"type": "resubmitted",
"count": 1,
"assignments": [
{
"id": 9274619,
"title": "Assignment 3",
"description": "",
"due": "",
"grading_scale": "0",
"grading_period": "31217",
"grading_category": "7813",
"max_points": "100",
"factor": "1",
"is_final": "0",
"show_comments": "0",
"grade_stats": "0",
"allow_dropbox": "1",
"allow_discussion": "1",
"published": 1,
"type": "assignment",
"grade_item_id": 9274619,
"available": 1,
"completed": 0,
"dropbox_locked": 0,
"grading_scale_type": 0,
"show_rubric": false,
"num_assignees": 0,
"assignees": [],
"section_id": "8495243",
"revisions": [
{
"revision_id": 15,
"uid": 81562,
"created": 1411075065,
"num_items": 1,
"late": 0,
"draft": 0
}
]
}
]
}
]
}
```
```xml
resubmitted
1
9274619
Assignment 3
0
31217
7813
100
1
0
0
0
1
1
1
assignment
9274619
1
0
0
0
0
8495243
15
81562
1411075065
1
0
0
```