> ## Documentation Index
> Fetch the complete documentation index at: https://docs.boxd.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Google Classroom

> Google Classroom is a free web service developed by Google for schools that aims to simplify creating, distributing, and grading assignments

Google Classroom is a free web service developed by Google for schools that aims to simplify creating, distributing, and grading assignments

`google-classroom` · **62 tools** · no triggers

## Connect it

```bash theme={"theme":"github-dark"}
run auth google-classroom
run auth google-classroom --scope team    # shared with the organization
```

Or from the [Integrations page](https://app.boxd.sh/integrations) in the console. See [Connections](/guides/integrations/connections) for personal versus shared, and who may remove one.

## Use it

```bash theme={"theme":"github-dark"}
run google-classroom          # common commands
run google-classroom --all    # every command
```

```ts theme={"theme":"github-dark"}
import { googleClassroom } from "@boxd/run";
```

## Common tools

| Tool                         | What it does                                                                                                                                                         |
| ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `courses-course-work-patch`  | Tool to update one or more fields of a course work. Use when you need to modify specific details of an existing course work after confirming which fields to update. |
| `courses-list`               | Tool to list all courses accessible to the authenticated user.                                                                                                       |
| `courses-students-create`    | Tool to add a student to a course. Use when enrolling a user as a student in a course.                                                                               |
| `courses-students-get`       | Tool to retrieve a specific student of a course. Use when you need to get detailed information about a student enrolled in a course by courseId and userId.          |
| `courses-update`             | Tool to update a course. Use when you need to modify course details like name, description, or state.                                                                |
| `course-work-get`            | Tool to get details of a specific coursework. Use when detailed information about a particular assignment is needed.                                                 |
| `course-work-list`           | Tool to list coursework in a course. Use after verifying courseId.                                                                                                   |
| `course-work-materials-get`  | Tool to get a coursework material. Use when you need to retrieve details of a specific coursework material by course and material ID.                                |
| `course-work-materials-list` | Tool to list course work materials in a course. Use when you need to retrieve and paginate materials for a given courseId.                                           |
| `user-profiles-get`          | Tool to retrieve a user profile by user ID. Use when you need to get information about a specific user including their name, email, photo, and permissions.          |

<Accordion title="All 62 tools" icon="list">
  | Tool                                        | What it does                                                                                                                                                               |
  | ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `courses-aliases-create`                    | Tool to create an alias for a course. Use when you need to add an alternative identifier to a course after confirming the course ID.                                       |
  | `courses-aliases-delete`                    | Tool to delete an alias of a course. Use when you need to remove an alias from a course after confirming the course ID and alias name.                                     |
  | `courses-aliases-list`                      | Tool to list aliases for a course. Use when you need to retrieve all aliases associated with a specific course.                                                            |
  | `courses-announcements-create`              | Tool to create an announcement in a course. Use after confirming the course ID is valid.                                                                                   |
  | `courses-announcements-delete`              | Tool to delete an announcement. Use after confirming the announcement ID.                                                                                                  |
  | `courses-announcements-get`                 | Tool to get an announcement. Use when you need to fetch an announcement by course and announcement ID.                                                                     |
  | `courses-announcements-get-add-on-context`  | Tool to get metadata for Classroom add-ons in the context of a specific announcement post.                                                                                 |
  | `courses-announcements-list`                | Tool to list announcements in a course. Use after you have the course ID to page through announcements.                                                                    |
  | `courses-announcements-modify-assignees`    | Tool to modify assignee mode and options of an announcement.                                                                                                               |
  | `courses-announcements-patch`               | Tool to update fields of an announcement. Use when you need to modify specific details of an existing announcement after confirming which fields to update.                |
  | `courses-announces-add-on-attachs-delete`   | Tool to delete an add-on attachment from a course announcement.                                                                                                            |
  | `courses-announces-add-on-attachs-get`      | Tool to get an add-on attachment from an announcement. Use when you need to retrieve a specific add-on attachment.                                                         |
  | `courses-announces-add-on-attachs-list`     | Tool to list all add-on attachments created under an announcement.                                                                                                         |
  | `courses-course-work-add-on-attachs-delete` | Tool to delete an add-on attachment from course work. Use when the add-on needs to remove an attachment it originally created.                                             |
  | `courses-course-work-get-add-on-context`    | Tool to get metadata for Classroom add-ons in the context of a specific course work.                                                                                       |
  | `courses-course-work-materials-add-attachs` | Tool to list all add-on attachments under a course work material post.                                                                                                     |
  | `courses-course-work-materials-delete`      | Tool to delete a course work material. Use after confirming the course work material ID and course ID.                                                                     |
  | `courses-course-work-modify-assignees`      | Tool to modify assignee mode and options of coursework. Use when you need to change who can view coursework, either making it visible to all students...                   |
  | `courses-course-work-patch`                 | Tool to update one or more fields of a course work. Use when you need to modify specific details of an existing course work after confirming which fields to update.       |
  | `courses-coursework-rubrics-list`           | Tool to list rubrics for a specific coursework. Use when you need to retrieve grading rubrics that the requester has permission to view.                                   |
  | `courses-create`                            | Tool to create a new course. Use when a teacher needs to establish a Classroom course before enrollment.                                                                   |
  | `courses-delete`                            | Tool to delete a course. Use when you need to remove a course after confirming the course ID.                                                                              |
  | `courses-get`                               | Tool to get details for a specific course. Use when you need full course information by ID.                                                                                |
  | `courses-get-grading-period-settings`       | Tool to retrieve grading period settings for a course. Use when you need to access the grading periods configured in a course.                                             |
  | `courses-list`                              | Tool to list all courses accessible to the authenticated user.                                                                                                             |
  | `courses-patch`                             | Tool to update one or more fields of a Classroom course. Use after retrieving course details and confirming fields to update.                                              |
  | `courses-posts-add-on-attachments-list`     | Tool to list all add-on attachments created under a post. Use when you need to retrieve attachments added by an add-on.                                                    |
  | `courses-posts-get-add-on-context`          | Tool to get metadata for Classroom add-ons in the context of a specific post.                                                                                              |
  | `courses-students-create`                   | Tool to add a student to a course. Use when enrolling a user as a student in a course.                                                                                     |
  | `courses-students-delete`                   | Tool to delete a student from a course. Use when you need to remove a student's enrollment from a specific course.                                                         |
  | `courses-students-get`                      | Tool to retrieve a specific student of a course. Use when you need to get detailed information about a student enrolled in a course by courseId and userId.                |
  | `courses-students-guardians-list`           | Tool to list guardians of a student in a course. Use when you need to retrieve and paginate guardians for a given student in a course.                                     |
  | `courses-students-list`                     | Tool to list students in a course. Use after you have the course ID to page through enrolled students.                                                                     |
  | `courses-teachers-delete`                   | Tool to delete a teacher from a course. Use when you need to remove a teacher's enrollment from a specific course.                                                         |
  | `courses-teachers-get`                      | Tool to get teacher enrollment. Use when you need to retrieve a specific teacher in a course by courseId and userId.                                                       |
  | `courses-teachers-list`                     | Tool to list teachers in a course. Use after you have the course ID to page through enrolled teachers.                                                                     |
  | `courses-topics-create`                     | Tool to create a course topic. Use when you need to organize course content into named sections.                                                                           |
  | `courses-topics-delete`                     | Tool to delete a course topic. Use when you need to remove a topic from a course after confirming the course and topic IDs.                                                |
  | `courses-topics-get`                        | Tool to get a course topic. Use when you need to retrieve details of a specific course topic by ID after confirming the course and topic IDs.                              |
  | `courses-topics-list`                       | Tool to list topics in a course. Use when you have confirmed the courseId and need to retrieve its topics.                                                                 |
  | `courses-topics-patch`                      | Tool to update fields of a course topic. Use when you need to rename a topic after confirming its current details.                                                         |
  | `courses-update`                            | Tool to update a course. Use when you need to modify course details like name, description, or state.                                                                      |
  | `courses-work-materials-patch`              | Tool to update fields of a course work material. Use when you need to modify specific details of an existing course work material after confirming which fields to update. |
  | `course-work-create`                        | Tool to create a CourseWork item in a course. Use when you need to assign an assignment or question to students immediately or on a schedule.                              |
  | `course-work-delete`                        | Tool to delete a specific CourseWork. Use when you need to remove a coursework item from a course after confirming the IDs.                                                |
  | `course-work-get`                           | Tool to get details of a specific coursework. Use when detailed information about a particular assignment is needed.                                                       |
  | `course-work-list`                          | Tool to list coursework in a course. Use after verifying courseId.                                                                                                         |
  | `course-work-materials-create`              | Tool to create course work material. Use when adding resources or notes to a course.                                                                                       |
  | `course-work-materials-get`                 | Tool to get a coursework material. Use when you need to retrieve details of a specific coursework material by course and material ID.                                      |
  | `course-work-materials-list`                | Tool to list course work materials in a course. Use when you need to retrieve and paginate materials for a given courseId.                                                 |
  | `course-work-student-submissions-list`      | Tool to list student submissions for a specific coursework. Use when you need to fetch or paginate student submissions by course and coursework...                         |
  | `course-work-student-submissions-reclaim`   | Tool to reclaim a student submission for editing. Use after a student requests to edit their turned-in submission, resetting its state to CREATED.                         |
  | `get-coursework-addon-attachment`           | Tool to get an add-on attachment from course work. Use when you need to retrieve a specific add-on attachment.                                                             |
  | `get-coursework-material-addon-context`     | Tool to get metadata for Classroom add-ons in the context of a specific course work material.                                                                              |
  | `invitations-create`                        | Tool to create an invitation for a user to a course. Use after confirming the course ID is valid.                                                                          |
  | `invitations-delete`                        | Tool to delete an invitation. Use when you need to remove an invitation after confirming the invitation ID.                                                                |
  | `invitations-get`                           | Tool to retrieve an invitation by its identifier. Use when you need to view invitation details.                                                                            |
  | `invitations-list`                          | Tool to list invitations that the requesting user is permitted to view.                                                                                                    |
  | `list-courses-student-groups`               | Tool to list student groups in a course. Use when you need to retrieve groups within a specific course.                                                                    |
  | `list-coursework-addon-attachments`         | Tool to list all add-on attachments created by an add-on under a course work.                                                                                              |
  | `registrations-create`                      | Tool to create a registration for push notifications from Google Classroom.                                                                                                |
  | `user-profiles-get`                         | Tool to retrieve a user profile by user ID. Use when you need to get information about a specific user including their name, email, photo, and permissions.                |
</Accordion>

[Open Google Classroom in the console →](https://app.boxd.sh/integrations/detail/google_classroom)
