Skip to main content
Google Classroom logo
  • Category: education
  • Auth: OAUTH2
  • Composio-managed OAuth available? Yes
  • Tools: 62
  • Triggers: 0
  • Slug: GOOGLE_CLASSROOM
  • Version: 20261101_00

Frequently Asked Questions

For a step-by-step guide on creating and configuring your own Google OAuth credentials with Composio, see How to create OAuth2 credentials for Google Apps.
The OAuth client is requesting scopes that Google hasn’t verified for that client. This usually happens when you add extra scopes beyond the defaults.Remove the additional scopes from your auth config, or create your own OAuth app and submit the scopes for verification. See How to create OAuth2 credentials for Google Apps.
When using custom OAuth credentials, the Google Classroom API must be enabled in the Google Cloud project that owns those credentials. Enable it in Google Cloud Console under APIs & Services, wait a few minutes, and retry.
The requested scopes are invalid or incorrectly formatted in the authorization URL. Verify your scope values against the Google OAuth scopes docs. If you’re creating auth configs programmatically, see the programmatic auth config guide.
The user’s access token is no longer valid. Common causes: the user revoked access, changed their password or 2FA, a Workspace admin policy changed, or Google’s refresh token limit (~50 per account) was exceeded. Re-authenticating the user typically resolves this.

Tools

Slug: GOOGLE_CLASSROOM_ACCEPT_INVITATIONAccept an invitation as the invited user, joining its course as a teacher or student. Removes the invitation on success. Only the invited user may accept it.

Input Parameters

string
required
Identifier of the invitation to accept.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_ADD_COURSE_TEACHERDirectly add a teacher to a course as a domain administrator. Domain administrators can add users within their domain to courses within their domain. Non-admin users should send an invitation instead. Fails if the user is already a teacher or student in the course.

Input Parameters

string
User to add: numeric user identifier, email address, or ‘me’ for the requesting user.
string
required
Classroom-assigned course identifier or course alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_ADD_STUDENT_GROUP_MEMBERAdd a student to an existing student group in a course. Fails if the member already exists, the group is full, or the caller lacks access.

Input Parameters

string
Identifier of the student to add.
string
required
Required. The identifier of the course in the request path.
string
Optional course identifier in the StudentGroupMember request body.
string
required
Required. The identifier of the student group in the request path.
string
Optional student group identifier in the StudentGroupMember request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_ALIASES_CREATETool to create an alias for a course. Use when you need to add an alternative identifier to a course after confirming the course ID.

Input Parameters

string
required
The alias to create. Must be unique within its scope and cannot exceed 256 characters. Domain-scoped aliases (prefix ‘d:’) can only be created by domain administrators. Project-scoped aliases (prefix ‘p:’) can be created by any project user.
string
required
Identifier of the course. This may either be the Classroom-assigned identifier or an alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_ALIASES_DELETETool 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.

Input Parameters

string
required
The alias to delete. This may not be the Classroom-assigned identifier.
string
required
Identifier of the course. This may either be the Classroom-assigned identifier or an alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_ALIASES_LISTList a page of aliases for a specified course, with optional page size and page token. A next-page token may be returned for retrieving further aliases.

Input Parameters

string
required
Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
integer
Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum.
string
nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_ANNOUNCEMENTS_CREATETool to create an announcement in a course. Use after confirming the course ID is valid.

Input Parameters

string
The text content of the announcement.
string ("DRAFT" | "PUBLISHED" | "DELETED")
State of the announcement; if omitted defaults to PUBLISHED.
string
required
Identifier of the course.
array
List of materials to attach to the announcement.
string ("ALL_STUDENTS" | "INDIVIDUAL_STUDENTS")
Mode for assigning the announcement; ALL_STUDENTS or INDIVIDUAL_STUDENTS.
string
RFC3339 timestamp at which to publish the announcement.
object
Options for INDIVIDUAL_STUDENTS assignee mode.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_ANNOUNCEMENTS_DELETETool to delete an announcement. Use after confirming the announcement ID.

Input Parameters

string
required
Identifier of the announcement to delete.
string
required
Identifier of the course.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_ANNOUNCEMENTS_GETTool to get an announcement. Use when you need to fetch an announcement by course and announcement ID.

Input Parameters

string
required
Identifier of the announcement to retrieve.
string
required
Identifier of the course. This identifier can be either the Classroom-assigned ID or an alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_ANNOUNCEMENTS_GET_ADD_ON_CONTEXTTool to get metadata for Classroom add-ons in the context of a specific announcement post. Use when validating query parameters and user permissions for add-ons loading in an iframe. Returns the current user’s role (student or teacher) with exactly one context field populated.

Input Parameters

string
required
Identifier of the Announcement, CourseWork, or CourseWorkMaterial with the attached add-on.
string
Deprecated. Use itemId instead.
string
required
Identifier of the course.
string
Optional authorization token passed when redirecting to the add-on’s URL. Required unless the add-on has attachments or the requesting project created the post.
string
Optional identifier for the specific attachment. Required for all requests except Attachment Discovery iframe.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_ANNOUNCEMENTS_LISTTool to list announcements in a course. Use after you have the course ID to page through announcements.

Input Parameters

string ("updateTime asc" | "updateTime desc")
How to sort announcements. Use updateTime desc (newest first) or updateTime asc (oldest first). Defaults to updateTime desc.
string
required
Identifier of the course whose announcements should be listed. Can be the Classroom-assigned identifier or an alias.
integer
Maximum number of announcements to return. Must be between 1 and 100. Defaults to 30 if not set.
string
Token specifying the next page of results to return. Obtain from a previous list call’s nextPageToken.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_ANNOUNCEMENTS_MODIFY_ASSIGNEESTool to modify assignee mode and options of an announcement. Use when you need to change who can view an announcement, either making it visible to all students or to specific students only.

Input Parameters

string
required
Identifier of the announcement.
string
required
Identifier of the course. This may be the Classroom-assigned identifier or an alias.
string ("ALL_STUDENTS" | "INDIVIDUAL_STUDENTS")
required
Mode of the announcement describing whether it is accessible by all students or specified individual students. Use ALL_STUDENTS for all students to see the item, or INDIVIDUAL_STUDENTS for a subset of students.
object
Options for modifying which students can view the announcement when assigneeMode is INDIVIDUAL_STUDENTS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_ANNOUNCEMENTS_PATCHTool to update fields of an announcement. Use when you need to modify specific details of an existing announcement after confirming which fields to update.

Input Parameters

string
required
Identifier of the announcement to update.
string
The text content of the announcement to set.
string ("DRAFT" | "PUBLISHED" | "DELETED")
State of the announcement.
string
required
Identifier of the course.
array
List of materials to attach to the announcement.
string
required
Comma-separated list of fields to update. E.g., ‘text,state’.
string ("ALL_STUDENTS" | "INDIVIDUAL_STUDENTS")
Mode for assigning the announcement; ALL_STUDENTS or INDIVIDUAL_STUDENTS.
string
RFC3339 timestamp at which to publish the announcement.
object
Options for INDIVIDUAL_STUDENTS assignee mode.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_ANNOUNCES_ADD_ON_ATTACHS_DELETETool to delete an add-on attachment from a course announcement. Requires the add-on to have been the original creator of the attachment.

Input Parameters

string
required
Identifier of the announcement under which the attachment is attached.
string
Deprecated. Use itemId instead. Optional identifier of the post.
string
required
Identifier of the course.
string
required
Identifier of the add-on attachment to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_ANNOUNCES_ADD_ON_ATTACHS_GETTool to get an add-on attachment from an announcement. Use when you need to retrieve a specific add-on attachment. Requires the add-on requesting the attachment to be the original creator.

Input Parameters

string
required
Identifier of the Announcement, CourseWork, or CourseWorkMaterial containing the attachment.
string
Deprecated. Use itemId instead. Optional identifier of the post.
string
required
Identifier of the course.
string
required
Identifier of the add-on attachment. Classroom-assigned identifier for this attachment, unique per post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_ANNOUNCES_ADD_ON_ATTACHS_LISTLists a page of add-on attachments under an announcement. Requires the add-on to have active attachments on the post or permission to create new attachments.

Input Parameters

string
required
Identifier of the Announcement, CourseWork, or CourseWorkMaterial whose attachments should be listed.
string
required
Identifier of the course.
integer
Maximum number of attachments to return. Default is 20, maximum is 20.
string
Token for retrieving the next page of results from a previous list response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_COURSE_WORK_ADD_ON_ATTACHS_DELETETool to delete an add-on attachment from course work. Use when the add-on needs to remove an attachment it originally created. Requires the add-on to have been the original creator of the attachment.

Input Parameters

string
required
Identifier of the Announcement, CourseWork, or CourseWorkMaterial under which the attachment is attached.
string
Optional. Deprecated, use itemId instead.
string
required
Identifier of the course.
string
required
Identifier of the attachment to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_COURSE_WORK_GET_ADD_ON_CONTEXTTool to get metadata for Classroom add-ons in the context of a specific course work. Use when validating query parameters and user permissions for add-ons loading in an iframe. Returns the current user’s role (student or teacher) with exactly one context field populated.

Input Parameters

string
required
Identifier of the Announcement, CourseWork, or CourseWorkMaterial with the attached add-on.
string
required
Identifier of the course.
string
Optional authorization token passed when redirecting to the add-on’s URL. Required unless the add-on has attachments or the requesting project created the post.
string
Optional identifier for the specific attachment. Required for all requests except Attachment Discovery iframe.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_COURSE_WORK_MATERIALS_ADD_ATTACHSTool to list all add-on attachments under a course work material post. Use when you need to retrieve attachments created by an add-on. Requires the add-on to have active attachments or permission to create new attachments on the post.

Input Parameters

string
required
Identifier of the Announcement, CourseWork, or CourseWorkMaterial resource.
string
required
Identifier of the course.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_COURSE_WORK_MATERIALS_DELETETool to delete a course work material. Use after confirming the course work material ID and course ID.

Input Parameters

string
required
Identifier of the course work material to delete.
string
required
Identifier of the course. This may either be the Classroom-assigned identifier or an alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_COURSE_WORK_MODIFY_ASSIGNEESTool 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 or to specific students only.

Input Parameters

string
required
Identifier of the coursework.
string
required
Identifier of the course. This may be the Classroom-assigned identifier or an alias.
string ("ALL_STUDENTS" | "INDIVIDUAL_STUDENTS")
required
Mode of the coursework describing whether it is accessible by all students or specified individual students. Use ALL_STUDENTS for all students to see the item, or INDIVIDUAL_STUDENTS for a subset of students.
object
Options for modifying which students can view the coursework when assigneeMode is INDIVIDUAL_STUDENTS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_COURSE_WORK_PATCHTool 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.

Input Parameters

string
required
Identifier of the course work to update.
string ("DRAFT" | "PUBLISHED" | "DELETED")
State of the course work. Can be DRAFT, PUBLISHED, or DELETED.
string
Title of the course work to set. Valid UTF-8, 1-3000 characters.
object
Model for due date.
object
Model for due time in request.
string
Topic ID to assign. Must match an existing course topic.
string
required
Identifier of the course. Can be the Classroom-assigned identifier or an alias.
array
Additional materials to attach (max 20 items).
number
Maximum grade points for the course work. Must be non-negative; zero indicates ungraded.
string
required
Comma-separated list of fields to update. Teachers can modify: title, description, state, dueDate, dueTime, maxPoints, scheduledTime, submissionModificationMode, topicId, gradingPeriodId.
string
Description of the course work to set. Maximum 30,000 characters.
string ("ALL_STUDENTS" | "INDIVIDUAL_STUDENTS")
Mode for assigning course work; defaults to ALL_STUDENTS.
string
RFC 3339 timestamp at which to publish the course work.
string
Grading period identifier.
object
Options for INDIVIDUAL_STUDENTS assignee mode.
string ("SUBMISSION_MODIFICATION_MODE_UNSPECIFIED" | "MODIFIABLE_UNTIL_TURNED_IN" | "MODIFIABLE")
Controls when students can modify submissions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_COURSEWORK_RUBRICS_LISTTool to list rubrics for a specific coursework. Use when you need to retrieve grading rubrics that the requester has permission to view.

Input Parameters

string
required
Identifier of the course. Can be the Classroom-assigned ID or an alias.
integer
Maximum number of items to return. Default and maximum is 1.
string
Token from a previous list call indicating the next page of results.
string
required
Identifier of the course work.
string
Optional preview version of the API that specifies new capabilities being previewed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_CREATETool to create a new course. Use when a teacher needs to establish a Classroom course before enrollment.

Input Parameters

string
required
Name of the course. Max length 750 characters.
string
Room location for the course. Max length 64 characters.
string
required
Identifier of the course owner. Can be the user’s numeric ID or email address.
string
Section of the course. Max length 2800 characters.
string ("COURSE_STATE_UNSPECIFIED" | "ACTIVE" | "ARCHIVED" | "PROVISIONED" | "DECLINED")
Initial state of the course.
string
Detailed description of the course. Max length 30,000 characters.
string
Heading for the course description. Max length 360 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_DELETETool to delete a course. Use when you need to remove a course after confirming the course ID.

Input Parameters

string
required
Identifier of the course to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_GETTool to get details for a specific course. Use when you need full course information by ID.

Input Parameters

string
required
Identifier of the course. This identifier can be either the Classroom-assigned ID or an alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_GET_GRADING_PERIOD_SETTINGSTool to retrieve grading period settings for a course. Use when you need to access the grading periods configured in a course.

Input Parameters

string
required
Identifier of the course. This can be the Classroom-assigned identifier or an alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_LISTTool to list all courses accessible to the authenticated user. Use when you need a paginated list of courses.

Input Parameters

integer
Maximum number of items to return. Must be ≥1.
string
Token identifying the page of results to return.
string
Restricts returned courses to those in which the student is enrolled. Can be the user’s numeric ID or ‘me’.
string
Restricts returned courses to those taught by the teacher. Can be the user’s numeric ID or ‘me’.
array
Restricts returned courses to those in specified states.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_PATCHTool to update one or more fields of a Classroom course. Use after retrieving course details and confirming fields to update.

Input Parameters

string
required
Identifier of the course to update.
string
New name of the course.
string
New room/location for the course.
string
New owner user ID for the course.
string
New section of the course.
string
required
Comma-separated list of fields to update. E.g., ‘name,section’.
string ("COURSE_STATE_UNSPECIFIED" | "ACTIVE" | "ARCHIVED" | "PROVISIONED" | "DECLINED")
New state of the course.
string
New detailed description of the course.
string
New heading for the course description.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_POSTS_ADD_ON_ATTACHMENTS_LISTTool to list all add-on attachments created under a post. Use when you need to retrieve attachments added by an add-on. Requires the add-on to have active attachments on the post or permission to create new attachments.

Input Parameters

string
Identifier of the Announcement, CourseWork, or CourseWorkMaterial whose attachments should be enumerated. Optional query parameter.
string
required
Identifier of the post under the course.
string
required
Identifier of the course.
integer
Maximum number of attachments to return. The service may return fewer than this value. If unspecified, at most 20 attachments will be returned.
string
A page token received from a previous list call. Provide this to retrieve the subsequent page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_POSTS_GET_ADD_ON_CONTEXTTool to get metadata for Classroom add-ons in the context of a specific post. Use when validating query parameters and user permissions for add-ons loading in an iframe. Returns the current user’s role (student or teacher) with exactly one context field populated.

Input Parameters

string
required
Identifier of the Announcement, CourseWork, or CourseWorkMaterial with the attached add-on.
string
required
Identifier of the post (path parameter, deprecated - but required in path).
string
required
Identifier of the course.
string
Optional authorization token passed when redirecting to the add-on’s URL. Required unless the add-on has attachments on the post or the requesting project created the post.
string
Optional identifier for the specific attachment. Required for all requests except Attachment Discovery iframe.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_STUDENTS_CREATETool to add a student to a course. Use when enrolling a user as a student in a course. Domain administrators can directly enroll users; students can self-enroll with an enrollment code.

Input Parameters

string
required
Identifier of the user to enroll as a student. Can be the numeric identifier for the user, the email address of the user, or the string literal “me” to indicate the requesting user.
string
required
Identifier of the course. Can be the Classroom-assigned identifier or an alias.
string
Enrollment code of the course. Required if the userId corresponds to the authenticated user. Optional for domain administrators who can directly enroll users.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_STUDENTS_DELETETool to delete a student from a course. Use when you need to remove a student’s enrollment from a specific course. This revokes their access to course materials and participation.

Input Parameters

string
required
Identifier of the student to delete. The identifier can be one of the following: the numeric identifier for the user, the email address of the user, or the string literal ‘me’ indicating the requesting user.
string
required
Identifier of the course. This may be the Classroom-assigned identifier or an alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_STUDENTS_GETTool 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.

Input Parameters

string
required
Identifier of the user. This can be the numeric identifier for the user, the email address of the user, or the literal string ‘me’ indicating the requesting user.
string
required
Identifier of the course. This may be the Classroom-assigned identifier or an alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_STUDENTS_GUARDIANS_LISTTool 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.

Input Parameters

string
required
Identifier of the course. Can be the Classroom-assigned ID or an alias.
integer
Maximum number of guardians to return. Must be between 1 and 100. Defaults to server’s default.
string
Token identifying which page of results to return.
string
required
Identifier of the student (the user’s id or email address, or ‘me’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_STUDENTS_LISTTool to list students in a course. Use after you have the course ID to page through enrolled students.

Input Parameters

string
required
Identifier of the course whose students should be listed. Can be the Classroom-assigned identifier or an alias.
integer
Maximum number of students to return. Must be between 1 and 100.
string
Token specifying which page of results to return. Obtain from a previous list call’s nextPageToken.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_TEACHERS_DELETETool to delete a teacher from a course. Use when you need to remove a teacher’s enrollment from a specific course. This revokes their teaching access to the course.

Input Parameters

string
required
Identifier of the teacher to delete. The identifier can be one of the following: the numeric identifier for the user, the email address of the user, or the string literal ‘me’ indicating the requesting user.
string
required
Identifier of the course. This may be the Classroom-assigned identifier or an alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_TEACHERS_GETTool to get teacher enrollment. Use when you need to retrieve a specific teacher in a course by courseId and userId.

Input Parameters

string
Selector specifying which fields to include in a partial response.
string
required
Identifier of the teacher to retrieve. Can be the teacher’s numeric user ID or email address.
string
required
Identifier of the course. This identifier can be either the Classroom-assigned ID or an alias.
string
Arbitrary string assigned to a user for quota purposes (server-side applications only).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_TEACHERS_LISTTool to list teachers in a course. Use after you have the course ID to page through enrolled teachers.

Input Parameters

string
required
Identifier of the course whose teachers should be listed.
integer
Maximum number of teachers to return. Must be between 1 and 100.
string
Token specifying which page of results to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_TOPICS_CREATETool to create a course topic. Use when you need to organize course content into named sections.

Input Parameters

string
required
Name of the topic.
string
required
Identifier of the course to create the topic in.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_TOPICS_DELETETool to delete a course topic. Use when you need to remove a topic from a course after confirming the course and topic IDs.

Input Parameters

string
required
Identifier of the topic to delete.
string
required
Identifier of the course.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_TOPICS_GETTool 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.

Input Parameters

string
required
Identifier of the topic to retrieve.
string
required
Identifier of the course. This can be the Classroom-assigned identifier or an alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_TOPICS_LISTTool to list topics in a course. Use when you have confirmed the courseId and need to retrieve its topics.

Input Parameters

string
required
Identifier of the course (Classroom-assigned ID or alias).
integer
Maximum number of topics to return; zero means no limit.
string
Token identifying which page of results to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_TOPICS_PATCHTool to update fields of a course topic. Use when you need to rename a topic after confirming its current details.

Input Parameters

string
required
Identifier of the topic.
string
New display name of the topic.
string
required
Identifier of the course.
string
Comma-separated list of fields to update. Currently only ‘name’ supported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_UPDATETool to update a course. Use when you need to modify course details like name, description, or state. This performs a full update (PUT) of the course.

Input Parameters

string
required
Identifier of the course to update. This can be either the Classroom-assigned identifier or an alias.
string
required
Name of the course. Max length 750 characters. Valid UTF-8.
string
Room location for the course. Max length 650 characters.
string
required
Identifier of the course owner. Can be the user’s numeric ID or email address. Only admins can modify this field.
string
Section designation of the course (e.g., ‘Period 2’). Max length 2,800 characters.
string ("COURSE_STATE_UNSPECIFIED" | "ACTIVE" | "ARCHIVED" | "PROVISIONED" | "DECLINED")
State of the course. Can be ACTIVE, ARCHIVED, PROVISIONED, or DECLINED.
string
Detailed description of the course. Max length 30,000 characters.
string
Optional heading for the course description. Max length 3,600 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSES_WORK_MATERIALS_PATCHTool 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.

Input Parameters

string
required
Identifier of the course work material to update.
string ("DRAFT" | "PUBLISHED" | "DELETED")
State of the course work material.
string
Title of the course work material (1-3,000 characters).
string
Identifier of the topic to associate with this material.
string
required
Identifier of the course. Can be the Classroom-assigned identifier or an alias.
string
required
Comma-separated list of fields to update. Supported fields: title, description, state, scheduledTime, topicId.
string
Description of the course work material (max 30,000 characters).
string
RFC3339 timestamp when the material is scheduled to be published.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSE_WORK_CREATETool 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.

Input Parameters

string ("DRAFT" | "PUBLISHED")
Whether to save as draft or publish immediately
string
required
Title of the coursework
object
Date portion of coursework due date (year, month, day).
object
Time portion of coursework due time (hours, minutes, seconds, nanos).
string
Topic ID to organize coursework under
string
required
Identifier of the course
string ("ASSIGNMENT" | "SHORT_ANSWER_QUESTION" | "MULTIPLE_CHOICE_QUESTION")
required
Type of coursework being created
array
Materials to attach to the coursework
number
Maximum points available for the coursework
object
Assignment details if workType is ASSIGNMENT
string
Detailed description or instructions
string
RFC3339 timestamp to auto-publish the coursework
object
Details for short-answer question.
object
Details for multiple-choice question.
string ("SUBMISSION_MODIFICATION_MODE_UNSPECIFIED" | "MODIFIABLE_UNTIL_TURNED_IN" | "MODIFIABLE")
Controls if students can edit submissions after turn-in

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSE_WORK_DELETETool to delete a specific CourseWork. Use when you need to remove a coursework item from a course after confirming the IDs.

Input Parameters

string
required
Identifier of the coursework item to delete.
string
required
Identifier of the course.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSE_WORK_GETTool to get details of a specific coursework. Use when detailed information about a particular assignment is needed.

Input Parameters

string
required
Identifier of the coursework item to retrieve.
string
required
Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSE_WORK_LISTTool to list coursework in a course. Use after verifying courseId.

Input Parameters

string
Sort ordering for results. Comma-separated list of fields with optional direction. Supported fields: ‘updateTime’, ‘dueDate’. Supported direction keywords: ‘asc’, ‘desc’. Default: ‘updateTime desc’.
string
required
Identifier of the course (Classroom-assigned ID or alias).
integer
Maximum number of items to return. Zero or unspecified indicates the server may assign a maximum. The server may return fewer than the specified number.
string
NextPageToken from a previous list call, indicating subsequent page of results to return. Must be used with otherwise identical request.
string
Preview version of the API. Set to access new capabilities in the Preview Program.
array
Restriction on the coursework state to return. Only coursework matching one of these states is returned. If unspecified, defaults to [‘PUBLISHED’].

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSE_WORK_MATERIALS_CREATETool to create course work material. Use when adding resources or notes to a course.

Input Parameters

string ("DRAFT" | "PUBLISHED" | "DELETED")
The state of the course work material (e.g., PUBLISHED, DRAFT).
string
Title of the course work material.
string
Identifier of the topic to which this material belongs.
string
required
Identifier of the course.
array
Materials attached to the course work material. Each element defines one of driveFile, link, form, or youtubeVideo.
string
Description of the course work material.
string ("ALL_STUDENTS" | "INDIVIDUAL_STUDENTS")
Who can see the material. Defaults to ALL_STUDENTS.
string
RFC3339 formatted time when the material is scheduled to be published, e.g., ‘2020-10-28T16:01:23Z’.
boolean
Whether this material is associated with a developer project.
object
Options for INDIVIDUAL_STUDENTS assignee mode.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSE_WORK_MATERIALS_GETTool to get a coursework material. Use when you need to retrieve details of a specific coursework material by course and material ID.

Input Parameters

string
required
Identifier of the coursework material.
string
required
Identifier of the course. Can be Classroom-assigned identifier or an alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSE_WORK_MATERIALS_LISTTool to list course work materials in a course. Use when you need to retrieve and paginate materials for a given courseId.

Input Parameters

string ("updateTime asc" | "updateTime desc")
Optional sorting order; allowed values are ‘updateTime asc’ or ‘updateTime desc’.
string
required
Identifier of the course whose courseWorkMaterials should be returned.
integer
Maximum number of items to return. Must be between 1 and 100. Defaults to 30.
string
Token identifying which page of results to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSE_WORK_STUDENT_SUBMISSIONS_LISTTool to list student submissions for a specific coursework. Use when you need to fetch or paginate student submissions by course and coursework, optionally filtering by user, state, or timeliness.

Input Parameters

string ("LATE_ONLY" | "NOT_LATE_ONLY")
Filters returned submissions to those that are on time or late.
array
Filters returned submissions to those in the specified states.
string
Restricts returned submissions to those owned by the specified user. Use numeric ID or ‘me’.
string
required
Identifier of the course.
integer
Maximum number of items to return. Defaults to 30; maximum is 100.
string
Token for next page of results.
string
required
Identifier of the coursework; use ’-’ to return submissions for all coursework in the course.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_COURSE_WORK_STUDENT_SUBMISSIONS_RECLAIMTool to reclaim a student submission for editing. Use after a student requests to edit their turned-in submission, resetting its state to CREATED.

Input Parameters

string
required
Identifier of the student submission.
string
required
Identifier of the course.
string
required
Identifier of the coursework.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_CREATE_ANNOUNCEMENT_ADDON_ATTACHMENTCreate an add-on attachment on an announcement. The add-on must have permission to create attachments on the parent post.

Input Parameters

string
Immutable Classroom-assigned attachment identifier, unique per post.
string
required
Required. Attachment title, between 1 and 1000 characters.
string
required
Required. Announcement identifier in the request path.
string
Deprecated query post identifier; use itemId instead.
object
Due date in UTC; must be specified together with dueTime.
object
Due time in UTC; must be specified together with dueDate.
string
required
Required. Course identifier in the request path.
number
Non-negative integer maximum grade. Requires studentWorkReviewUri; zero disables grade passback, nonzero enables it.
string
Authorization token from the Classroom redirect. Required for in-Classroom creation; optional for partner-first creation when the attachment and parent developer projects match.
string
Immutable parent post identifier in the attachment body, unique per course.
string
Deprecated immutable post identifier in the attachment body; use bodyItemId instead.
string
Immutable course identifier in the attachment body.
object
required
Required. Student view URI; Classroom adds courseId, itemId, itemType, and attachmentId query parameters.
object
required
Required. Teacher view URI; Classroom adds courseId, itemId, itemType, and attachmentId query parameters.
object
Teacher student-work review URI; also receives submissionId. If omitted or removed, maxPoints is discarded.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_CREATE_COURSEWORK_ADDON_ATTACHMENTCreate an add-on attachment on course work. The add-on must have permission to create attachments on the parent post.

Input Parameters

string
Immutable Classroom-assigned attachment identifier, unique per post.
string
required
Required. Attachment title, between 1 and 1000 characters.
string
required
Required. Course work identifier in the request path.
string
Deprecated query post identifier; use itemId instead.
object
Due date in UTC; must be specified together with dueTime.
object
Due time in UTC; must be specified together with dueDate.
string
required
Required. Course identifier in the request path.
number
Non-negative integer maximum grade. Requires studentWorkReviewUri; zero disables grade passback, nonzero enables it.
string
Authorization token from the Classroom redirect. Required for in-Classroom creation; optional for partner-first creation when the attachment and parent developer projects match.
string
Immutable parent post identifier in the attachment body, unique per course.
string
Deprecated immutable post identifier in the attachment body; use bodyItemId instead.
string
Immutable course identifier in the attachment body.
object
required
Required. Student view URI; Classroom adds courseId, itemId, itemType, and attachmentId query parameters.
object
required
Required. Teacher view URI; Classroom adds courseId, itemId, itemType, and attachmentId query parameters.
object
Teacher student-work review URI; also receives submissionId. If omitted or removed, maxPoints is discarded.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_CREATE_MATERIAL_ADDON_ATTACHMENTCreate an add-on attachment on a course work material. The add-on must have permission to create attachments on the parent post.

Input Parameters

string
Immutable Classroom-assigned attachment identifier, unique per post.
string
required
Required. Attachment title, between 1 and 1000 characters.
string
required
Required. Course work material identifier in the request path.
string
Deprecated query post identifier; use itemId instead.
object
Due date in UTC; must be specified together with dueTime.
object
Due time in UTC; must be specified together with dueDate.
string
required
Required. Course identifier in the request path.
number
Non-negative integer maximum grade. Requires studentWorkReviewUri; zero disables grade passback, nonzero enables it.
string
Authorization token from the Classroom redirect. Required for in-Classroom creation; optional for partner-first creation when the attachment and parent developer projects match.
string
Immutable parent post identifier in the attachment body, unique per course.
string
Deprecated immutable post identifier in the attachment body; use bodyItemId instead.
string
Immutable course identifier in the attachment body.
object
required
Required. Student view URI; Classroom adds courseId, itemId, itemType, and attachmentId query parameters.
object
required
Required. Teacher view URI; Classroom adds courseId, itemId, itemType, and attachmentId query parameters.
object
Teacher student-work review URI; also receives submissionId. If omitted or removed, maxPoints is discarded.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_CREATE_RUBRICCreate a rubric for course work using criteria or a formatted spreadsheet. The requesting user and course owner need rubric creation capabilities and the required license. Use the OAuth developer project that created the parent course work item. Spreadsheet imports also require a Google Sheets scope.

Input Parameters

string
required
Required course identifier.
array
Rubric criteria, each describing a dimension of performance. Use either criteria or sourceSpreadsheetId.
string
required
Required course work identifier.
string
Input-only, immutable Google Sheets ID containing formatted rubric settings. Requires spreadsheets.readonly or spreadsheets scope in addition to Classroom authorization. Use instead of criteria.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_CREATE_STUDENT_GROUPCreate a student group for a course. Fails if the caller lacks access or the course has reached its maximum number of student groups.

Input Parameters

string
The identifier of the student group.
string
The title of the student group.
string
required
Required. The identifier of the course in the request path.
string
Optional course identifier in the StudentGroup request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_DELETE_MATERIAL_ADDON_ATTACHMENTDelete an add-on attachment from a course work material using its identifiers. Requires the calling add-on to have originally created the attachment.

Input Parameters

string
required
Identifier of the course work material containing the attachment.
string
Deprecated optional post identifier. Use itemId instead.
string
required
Identifier of the course.
string
required
Identifier of the attachment to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_DELETE_REGISTRATIONDelete a notification registration, stopping Classroom notifications for it. Use when notifications for an existing registration are no longer needed.

Input Parameters

string
required
The registration_id of the notification registration to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_DELETE_RUBRICDelete a rubric before grading has started using its course and work IDs. The requesting user and course owner must have rubric creation capabilities. The request must use the developer project that created the rubric.

Input Parameters

string
required
Identifier of the rubric to delete.
string
required
Identifier of the course.
string
required
Identifier of the course work.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_DELETE_STUDENT_GROUPDelete a student group from a course using its course and student group IDs. Use when an existing student group is no longer needed.

Input Parameters

string
required
Identifier of the student group to delete.
string
required
Identifier of the course containing the student group to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_DELETE_STUDENT_GUARDIANDelete a student’s guardian to stop their guardian notifications. Use after confirming the student and guardian IDs. The guardian will no longer receive guardian notifications or be accessible through the API.

Input Parameters

string
required
Student’s numeric user identifier, email address, or ‘me’ for the requesting user.
string
required
The id field of the Guardian to delete for this student.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_GET_ADDON_ATTACHMENT_SUBMISSIONRetrieve a student’s submission for a course work add-on attachment using the course, course work, attachment, and submission IDs.

Input Parameters

string
required
Identifier of the parent course work.
string
Deprecated parent post identifier; use itemId instead.
string
required
Identifier of the course.
string
required
Identifier of the add-on attachment.
string
required
Identifier of the student’s submission.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_GET_COURSEWORK_ADDON_ATTACHMENTTool to get an add-on attachment from course work. Use when you need to retrieve a specific add-on attachment. Requires the add-on requesting the attachment to be the original creator.

Input Parameters

string
required
Identifier of the CourseWork item containing the attachment.
string
required
Identifier of the course.
string
required
Identifier of the add-on attachment. Classroom-assigned identifier for this attachment, unique per post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_GET_COURSEWORK_MATERIAL_ADDON_CONTEXTTool to get metadata for Classroom add-ons in the context of a specific course work material. Use when validating query parameters for add-ons loading in an iframe. Returns course/item identifiers and role-specific context.

Input Parameters

string
required
Identifier of the Announcement, CourseWork, or CourseWorkMaterial resource.
string
required
Identifier of the course.
string
Optional. Authorization token passed when redirected from Classroom. Required unless the add-on has attachments or the developer project created the post.
string
Optional. The attachment identifier. Required for most requests except Attachment Discovery iframe scenarios.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_GET_GUARDIAN_INVITATIONRetrieve a specific guardian invitation for a student by invitation ID. Requires permission to view the student’s guardian invitations and guardians to be enabled for the domain. The invited email is visible only to domain administrators.

Input Parameters

string
required
Student’s numeric user identifier, email address, or ‘me’ for the requesting user.
string
required
The id of the GuardianInvitation to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_GET_MATERIAL_ADDON_ATTACHMENTRetrieve an add-on attachment on a course work material by its IDs. The requesting add-on must be the attachment’s original creator.

Input Parameters

string
required
Identifier of the course work material.
string
Deprecated post identifier; use itemId instead.
string
required
Identifier of the course.
string
required
Identifier of the add-on attachment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_GET_RUBRICRetrieve a rubric’s criteria, scoring levels, and timestamps using its course, course work, and rubric IDs.

Input Parameters

string
required
Identifier of the rubric.
string
required
Identifier of the course.
string
required
Identifier of the course work.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_GET_STUDENT_GUARDIANRetrieve a specific guardian relationship for a student using the guardian ID. Requires permission to view the student’s guardian information and guardians to be enabled for the domain.

Input Parameters

string
required
Student’s numeric user identifier, email address, or ‘me’ for the requesting user.
string
required
Identifier of the guardian from a Guardian resource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_GET_STUDENT_SUBMISSIONRetrieve one student’s submission by course, course work, and submission ID, including available answers, attachments, grades, and history.

Input Parameters

string
required
Identifier of the student submission.
string
required
Classroom-assigned course identifier or course alias.
string
required
Identifier of the course work.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_INVITATIONS_CREATETool to create an invitation for a user to a course. Use after confirming the course ID is valid.

Input Parameters

string ("STUDENT" | "TEACHER")
required
Role to invite the user as.
string
required
Identifier of the user to invite. Can be the user’s numeric ID or email address.
string
required
Identifier of the course to invite the user to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_INVITATIONS_DELETETool to delete an invitation. Use when you need to remove an invitation after confirming the invitation ID.

Input Parameters

string
required
Identifier of the invitation to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_INVITATIONS_GETTool to retrieve an invitation by its identifier. Use when you need to view invitation details.

Input Parameters

string
required
Identifier of the invitation to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_INVITATIONS_LISTTool to list invitations that the requesting user is permitted to view. At least one of userId or courseId must be supplied.

Input Parameters

string
Restricts returned invitations to those for a specific user. Can be the user’s numeric identifier, email address, or ‘me’ for the requesting user. At least one of userId or courseId must be supplied.
string
Restricts returned invitations to those for a course with the specified identifier. At least one of userId or courseId must be supplied.
integer
Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
string
Token identifying the next page of results to return. Obtained from a previous list call’s nextPageToken.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_INVITE_STUDENT_GUARDIANInvite a student’s guardian by email to receive guardian notifications. Requires permission to manage guardians and guardians enabled for the domain. Sends an email asking the guardian to confirm their relationship to the student. Fails if the guardian already exists or a matching invitation is pending.

Input Parameters

string
Optional initial invitation state; only PENDING is accepted.
string
required
Student identifier in standard format, used in the path and body.
string
required
Email address of the guardian to invite.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_LIST_ADDON_ATTACHMENT_SUBMISSIONSList one page of student submissions the requester may view for a course work add-on attachment. Use nextPageToken as pageToken to retrieve subsequent pages.

Input Parameters

string
required
Identifier of the course work containing the attachment.
string
required
Identifier of the course.
integer
Maximum submissions to return. Zero or omitted lets the server choose a maximum; fewer results may be returned.
string
Token from a previous list response to retrieve the next page. All other parameters must match the call that returned the token.
string
required
Identifier of the add-on attachment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_LIST_COURSES_STUDENT_GROUPSTool to list student groups in a course. Use when you need to retrieve groups within a specific course.

Input Parameters

string
required
Identifier of the course. Can be the Classroom-assigned identifier or an alias.
integer
Maximum number of items to return. Zero or unspecified indicates no limit.
string
Token specifying which page of results to return. Obtain from a previous list call’s nextPageToken.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_LIST_COURSEWORK_ADDON_ATTACHMENTSTool to list all add-on attachments created by an add-on under a course work. Use when you need to retrieve attachments added by an add-on to course work.

Input Parameters

string
required
Identifier of the CourseWork whose attachments should be listed.
string
required
Identifier of the course.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_LIST_GUARDIAN_INVITATIONSList one page of guardian invitations for a student, or use studentId ’-’ as a domain administrator to list all accessible students’ invitations. Guardians must be enabled for the domain and the caller must have permission to view invitations. Defaults to PENDING invitations; use states to filter and nextPageToken for subsequent pages.

Input Parameters

array
Filter by invitation states. If omitted, only PENDING invitations are returned. COMPLETE includes accepted, declined, withdrawn, or expired invitations. GUARDIAN_INVITATION_STATE_UNSPECIFIED should never be returned.
integer
Maximum number of items to return. Zero or unspecified lets the server assign a maximum; fewer results may be returned.
string
nextPageToken from a previous list call. All other request parameters must remain identical.
string
required
Student numeric ID, email address, ‘me’ for the requesting user, or ’-’ for all accessible students (domain administrators only).
string
Return only invitations sent to this email address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_LIST_STUDENT_GROUP_MEMBERSList one page of students in a course’s student group. Use nextPageToken to retrieve subsequent pages. Fails if the course or student group does not exist.

Input Parameters

string
required
Required. The identifier of the course.
integer
Maximum number of items to return. Zero or unspecified lets the server assign a maximum; fewer results may be returned.
string
nextPageToken from a previous list call. All other request parameters must match that call.
string
required
Required. The identifier of the student group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_LIST_STUDENT_GUARDIANSList one page of guardians for a student, or use studentId ’-’ as a domain administrator to list all accessible students’ guardians. Guardians must be enabled for the domain and the caller must have permission to view them. Use nextPageToken for subsequent pages.

Input Parameters

integer
Maximum number of items to return. Zero or unspecified lets the server assign a maximum; fewer results may be returned.
string
nextPageToken from a previous list call. All other request parameters must remain identical.
string
required
Student numeric ID, email address, ‘me’ for the requesting user, or ’-’ for all accessible students (domain administrators only).
string
Filter by the email address to which the original invitation was sent. Only domain administrators may use this filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_MODIFY_STUDENT_SUBMISSION_ATTACHMENTSAdd attachments to an ASSIGNMENT student submission and return the updated submission. Form attachments are unsupported. The OAuth client must belong to the Developer Console project that created the course work or an add-on attachment on it.

Input Parameters

string
required
Identifier of the student submission.
string
required
Classroom-assigned course identifier or course alias.
string
required
Identifier of the course work.
array
Attachments to add. A submission may have at most 20 attachments. Form attachments are not supported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_REGISTRATIONS_CREATETool to create a registration for push notifications from Google Classroom. Use when you need to set up notifications from a specific feed to a Cloud Pub/Sub topic. Requires the OAuth scope https://www.googleapis.com/auth/classroom.push-notifications.

Input Parameters

object
required
Specification of the feed to subscribe to. The feedType determines which notifications will be sent, and conditional info fields must be provided based on the feedType.
object
required
The Cloud Pub/Sub topic where notifications will be published. Classroom must have permission to publish to this topic.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_REMOVE_STUDENT_GROUP_MEMBERRemove a student from a specific student group using the course, group, and user IDs. Use to remove group membership without removing the student from the course.

Input Parameters

string
required
Identifier of the student group member to remove.
string
required
Identifier of the course containing the relevant student group.
string
required
Identifier of the student group containing the member to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_RETURN_STUDENT_SUBMISSIONReturn a student submission, transferring attached Drive files to the student. May also update the submission state; does not copy draftGrade to assignedGrade. Only a teacher of the course may call this method. The OAuth client must belong to the Developer Console project that created the course work or an add-on attachment on that course work. Returns an empty response on success.

Input Parameters

string
required
Identifier of the student submission.
string
required
Classroom-assigned course identifier or course alias.
string
required
Identifier of the course work.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_TURN_IN_STUDENT_SUBMISSIONTurn in a student submission, transferring attached Drive files to the teacher. May also update the submission state. Only the student who owns the submission may call this method. The OAuth client must belong to the Developer Console project that created the course work or an add-on attachment on that course work. Returns an empty response on success.

Input Parameters

string
required
Identifier of the student submission.
string
required
Classroom-assigned course identifier or course alias.
string
required
Identifier of the course work.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_UPDATE_ADDON_ATTACHMENT_SUBMISSIONUpdate a student’s add-on attachment grade on course work using a field mask. The requesting add-on must have created the attachment, and the attachment must have a positive max_points value. Teachers may update points_earned.

Input Parameters

string
required
Required parent course work identifier.
string
Deprecated parent post identifier query parameter; use itemId.
string
required
Required course identifier.
string
required
Required field mask. Teachers may specify points_earned. To clear a supported field, include it in the mask and omit its body value.
string
required
Required add-on attachment identifier.
number
Student grade on this attachment; unset means no grade.
string
required
Required student submission identifier.
string ("SUBMISSION_STATE_UNSPECIFIED" | "NEW" | "CREATED" | "TURNED_IN" | "RETURNED" | "RECLAIMED_BY_STUDENT")
Submission state of the attachment’s parent assignment. Present in the resource schema, but not a supported teacher update-mask field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_UPDATE_ANNOUNCEMENT_ADDON_ATTACHMENTUpdate an add-on attachment on an announcement using a field mask. The requesting add-on must be the attachment’s original creator. Only the documented teacher-editable fields may appear in updateMask.

Input Parameters

string
Immutable Classroom-assigned attachment identifier in the body; not a supported update-mask field.
string
Attachment title, between 1 and 1000 characters when set.
string
required
Required parent announcement identifier in the path.
string
Legacy parent post identifier query parameter; use itemId.
object
Due date in UTC; must be paired with dueTime when specified.
object
Due time in UTC; must be paired with dueDate when specified.
string
required
Required course identifier in the path.
number
Non-negative integer-valued maximum grade, requiring studentWorkReviewUri. Zero disables grade passback; nonzero enables it.
string
Immutable parent post identifier in the attachment body; not a supported update-mask field.
string
Deprecated immutable post identifier in the body; use bodyItemId.
string
required
Required comma-separated field mask. Teachers may update title, teacher_view_uri, student_view_uri, student_work_review_uri, due_date, due_time, max_points. To clear a field that supports empty values, include it in the mask and omit its body value.
string
required
Required attachment identifier in the path.
string
Immutable course identifier in the attachment body; not a supported update-mask field.
object
Student view URI, opened with courseId, itemId, itemType, and attachmentId query parameters.
object
Teacher view URI, opened with courseId, itemId, itemType, and attachmentId query parameters.
object
Teacher student-work review URI, also opened with submissionId. Removing it discards maxPoints.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_UPDATE_COURSEWORK_ADDON_ATTACHMENTUpdate an add-on attachment on course work using a field mask. The requesting add-on must be the attachment’s original creator. Only the documented teacher-editable fields may appear in updateMask.

Input Parameters

string
Immutable Classroom-assigned attachment identifier in the body; not a supported update-mask field.
string
Attachment title, between 1 and 1000 characters when set.
string
required
Required parent course work identifier in the path.
string
Legacy parent post identifier query parameter; use itemId.
object
Due date in UTC; must be paired with dueTime when specified.
object
Due time in UTC; must be paired with dueDate when specified.
string
required
Required course identifier in the path.
number
Non-negative integer-valued maximum grade, requiring studentWorkReviewUri. Zero disables grade passback; nonzero enables it.
string
Immutable parent post identifier in the attachment body; not a supported update-mask field.
string
Deprecated immutable post identifier in the body; use bodyItemId.
string
required
Required comma-separated field mask. Teachers may update title, teacher_view_uri, student_view_uri, student_work_review_uri, due_date, due_time, max_points. To clear a field that supports empty values, include it in the mask and omit its body value.
string
required
Required attachment identifier in the path.
string
Immutable course identifier in the attachment body; not a supported update-mask field.
object
Student view URI, opened with courseId, itemId, itemType, and attachmentId query parameters.
object
Teacher view URI, opened with courseId, itemId, itemType, and attachmentId query parameters.
object
Teacher student-work review URI, also opened with submissionId. Removing it discards maxPoints.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_UPDATE_COURSEWORK_RUBRICUpdate a course work rubric, replacing selected criteria or importing a spreadsheet. Omitted criteria and levels are deleted when replacing criteria. The requesting user and course owner need rubric creation capabilities and the required license. Use the OAuth developer project that created the parent course work. Updates are limited once grading starts.

Input Parameters

string
Optional rubric identifier, sent as a query parameter.
string
required
Required course identifier.
array
Replacement rubric criteria. Use either criteria or sourceSpreadsheetId, not both.
string
Field mask required by the provider for an update: criteria or source_spreadsheet_id. Criteria fully replaces the list: omitted criteria and levels are deleted, existing IDs are retained, and new items receive IDs.
string
required
Required course work identifier.
string
Input-only, immutable Google Sheets ID containing formatted rubric settings. Requires spreadsheets.readonly or spreadsheets scope in addition to Classroom authorization. Use instead of criteria.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_UPDATE_GRADING_PERIOD_SETTINGSUpdate a course’s grading period settings. The requesting user and course owner must meet Classroom’s grading period licensing requirements. Updating grading_periods replaces the entire list, deleting omitted periods. Preserve existing period IDs to edit periods; omit IDs only for new periods.

Input Parameters

string
required
Required course identifier.
string
Comma-separated fields to update: grading_periods and apply_to_existing_coursework. Updating grading_periods fully replaces the list; omitted existing periods are deleted and periods without IDs are added.
array
Grading periods in chronological order with non-overlapping inclusive date ranges and unique titles. An empty list clears periods when selected by updateMask. Preserve existing IDs to edit periods; omit IDs to add periods.
boolean
Whether grading periods apply to existing stream items. Persists across updates; defaults to false if never set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_UPDATE_MATERIAL_ADDON_ATTACHMENTUpdate an add-on attachment on a course work material using a field mask. The requesting add-on must be the attachment’s original creator. Only the documented teacher-editable fields may appear in updateMask.

Input Parameters

string
Immutable Classroom-assigned attachment identifier in the body; not a supported update-mask field.
string
Attachment title, between 1 and 1000 characters when set.
string
required
Required parent course work material identifier in the path.
string
Legacy parent post identifier query parameter; use itemId.
object
Due date in UTC; must be paired with dueTime when specified.
object
Due time in UTC; must be paired with dueDate when specified.
string
required
Required course identifier in the path.
number
Non-negative integer-valued maximum grade, requiring studentWorkReviewUri. Zero disables grade passback; nonzero enables it.
string
Immutable parent post identifier in the attachment body; not a supported update-mask field.
string
Deprecated immutable post identifier in the body; use bodyItemId.
string
required
Required comma-separated field mask. Teachers may update title, teacher_view_uri, student_view_uri, student_work_review_uri, due_date, due_time, max_points. To clear a field that supports empty values, include it in the mask and omit its body value.
string
required
Required attachment identifier in the path.
string
Immutable course identifier in the attachment body; not a supported update-mask field.
object
Student view URI, opened with courseId, itemId, itemType, and attachmentId query parameters.
object
Teacher view URI, opened with courseId, itemId, itemType, and attachmentId query parameters.
object
Teacher student-work review URI, also opened with submissionId. Removing it discards maxPoints.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_UPDATE_RUBRICUpdate a rubric by ID, replacing criteria or importing a formatted spreadsheet. Replacing criteria deletes omitted criteria and levels. The requesting user and course owner need rubric creation capabilities and the required license. Use the OAuth developer project that created the parent course work. Updates are limited once grading has started.

Input Parameters

string
required
Required rubric identifier in the path.
string
required
Required course identifier in the path.
array
Replacement rubric criteria. Use either criteria or sourceSpreadsheetId, not both.
string
Field mask required by the provider to update the rubric. Teachers may specify criteria or source_spreadsheet_id. Criteria fully replaces the list: omitted criteria and levels are deleted, existing IDs are retained, and new items receive IDs.
string
required
Required course work identifier in the path.
string
Input-only, immutable Google Sheets ID containing formatted rubric settings. Requires spreadsheets.readonly or spreadsheets scope in addition to Classroom authorization. Use instead of criteria.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_UPDATE_STUDENT_GROUPUpdate a student group’s title as a teacher using the required updateMask. Fails if the group is inaccessible or missing, or if the mask is invalid.

Input Parameters

string
required
Required. Student group identifier in the path.
string
The title of the student group.
string
Optional student group identifier in the StudentGroup body. Not a supported teacher updateMask field.
string
required
Required. Course identifier in the path.
string
required
Required field mask identifying fields to update. Teachers may specify title; invalid fields cause the update to fail.
string
Optional course identifier in the StudentGroup body. Not a supported teacher updateMask field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_UPDATE_STUDENT_SUBMISSIONUpdate a student submission’s draft or assigned grade as a teacher. The OAuth developer project must have created the course work or a Grade Sync-enabled add-on attachment on it. Only draft_grade and assigned_grade are supported updateMask fields; use ModifyAttachments for attachments.

Input Parameters

string
required
Student submission identifier.
string
required
Course identifier or alias.
number
Pending grade, modifiable only by teachers; rounded to two decimal places.
string
required
Required comma-separated field mask. Teachers may update draft_grade and assigned_grade.
string
required
Course work identifier.
number
Assigned grade, modifiable only by teachers; rounded to two decimal places.
object
Assignment content; changes require ModifyAttachments rather than this method.
object
Short-answer content; not a supported teacher updateMask field.
object
Multiple-choice content; not a supported teacher updateMask field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_USER_PROFILES_GETTool 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.

Input Parameters

string
required
Identifier of the user to retrieve. Can be the numeric user identifier, user’s email address, or the literal string ‘me’ to indicate the requesting user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CLASSROOM_WITHDRAW_GUARDIAN_INVITATIONWithdraw a pending guardian invitation by setting state to COMPLETE with updateMask=state. Only the PENDING to COMPLETE transition is permitted. Requires permission to manage guardians and guardians enabled for the domain; fails for non-pending invitations, invalid updates, or missing students or invitations.

Input Parameters

string
Set to COMPLETE to withdraw the invitation. Only PENDING to COMPLETE is permitted; other states or changes to other fields are rejected by the provider.
string
required
Student identifier or email address in the request path.
string
required
Required update mask. Only state is a supported update field.
string
required
Identifier of the guardian invitation to withdraw.
string
Optional student ID in standard format in the GuardianInvitation body. Not a supported updateMask field; only state can be modified.
string
Email address the invitation was sent to, visible only to domain administrators. Not a supported updateMask field; only state can be modified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not