Google Classroom add-ons are now generally available to developers! Please see the
add-ons documentation for more information.
Method: courses.get
Returns a course.
This method returns the following error codes:
PERMISSION_DENIED if the requesting user is not permitted to access the requested course or for access errors.NOT_FOUND if no course exists with the requested ID.
HTTP request
GET https://classroom.googleapis.com/v1/courses/{id}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
id |
string
Identifier of the course to return. This identifier can be either the Classroom-assigned identifier or an alias.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of Course.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/classroom.courses
https://www.googleapis.com/auth/classroom.courses.readonly
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 2024-09-04 UTC.
[null,null,["Last updated 2024-09-04 UTC."],[[["This method returns a course based on its ID, which can be either Classroom-assigned or an alias."],["Users need to have appropriate authorization scopes, either `classroom.courses` or `classroom.courses.readonly`, to access the course data."],["Possible error codes include `PERMISSION_DENIED` if the user lacks access or `NOT_FOUND` if the course ID is invalid."],["The request body should be empty, and a successful response will contain a [Course](/classroom/reference/rest/v1/courses#Course) object."],["This endpoint uses a `GET` request with the course ID as a path parameter, following gRPC Transcoding syntax."]]],[]]
