Google Classroom add-ons are now generally available to developers! Please see the
add-ons documentation for more information.
Method: courses.courseWorkMaterials.addOnAttachments.list
Stay organized with collections
Save and categorize content based on your preferences.
Returns all attachments created by an add-on under the post.
Requires the add-on to have active attachments on the post or have permission to create new attachments on the post.
This method returns the following error codes:
PERMISSION_DENIED for access errors.INVALID_ARGUMENT if the request is malformed.NOT_FOUND if one of the identified resources does not exist.
HTTP request
GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
courseId |
string
Required. Identifier of the course.
|
itemId |
string
Identifier of the Announcement, CourseWork, or CourseWorkMaterial whose attachments should be enumerated. This field is required, but is not marked as such while we are migrating from postId.
|
Query parameters
| Parameters |
postId
(deprecated) |
string
Optional. Identifier of the post under the course whose attachments to enumerate. Deprecated, use itemId instead.
|
pageSize |
integer
The maximum number of attachments to return. The service may return fewer than this value. If unspecified, at most 20 attachments will be returned. The maximum value is 20; values above 20 will be coerced to 20.
|
pageToken |
string
A page token, received from a previous addOnAttachments.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to addOnAttachments.list must match the call that provided the page token.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of ListAddOnAttachmentsResponse.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/classroom.addons.student
https://www.googleapis.com/auth/classroom.addons.teacher
For more information, see the Authorization guide.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-17 UTC.
[null,null,["Last updated 2025-04-17 UTC."],[],[],null,["# Method: courses.courseWorkMaterials.addOnAttachments.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n\nReturns all attachments created by an add-on under the post.\n\nRequires the add-on to have active attachments on the post or have permission to create new attachments on the post.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` for [access errors](/workspace/classroom/reference/Access.Errors).\n- `INVALID_ARGUMENT` if the request is malformed.\n- `NOT_FOUND` if one of the identified resources does not exist.\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `courseId` | `string` Required. Identifier of the course. |\n| `itemId` | `string` Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` whose attachments should be enumerated. This field is required, but is not marked as such while we are migrating from postId. |\n\n### Query parameters\n\n| Parameters ||\n|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `postId` **(deprecated)** | `string` Optional. Identifier of the post under the course whose attachments to enumerate. Deprecated, use `itemId` instead. |\n| `pageSize` | `integer` The maximum number of attachments to return. The service may return fewer than this value. If unspecified, at most 20 attachments will be returned. The maximum value is 20; values above 20 will be coerced to 20. |\n| `pageToken` | `string` A page token, received from a previous `addOnAttachments.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `addOnAttachments.list` must match the call that provided the page token. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [ListAddOnAttachmentsResponse](/workspace/classroom/reference/rest/v1/ListAddOnAttachmentsResponse).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/classroom.addons.student`\n- `\n https://www.googleapis.com/auth/classroom.addons.teacher`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
