GOgoogle
courses

GET /v1/courses

Changed on

Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. Returned courses are ordered by creation time, with the most recently created coming first. This method returns the following error codes: * PERMISSION_DENIED for access errors. * INVALID_ARGUMENT if the query argument is malformed. * NOT_FOUND if any users specified in the query arguments do not exist.

Request

  • Base URL
    https://classroom.googleapis.com
  • URL
    https://classroom.googleapis.com/v1/courses
  • Auth
    • OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/classroom.courses
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/classroom.courses
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/classroom.courses.readonly
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/classroom.courses.readonly

Query parameters

courseStatesstring[]

Restricts returned courses to those in one of the specified states. If unspecified, Courses in any state are returned.

pageSizeinteger

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.

pageTokenstring

nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

studentIdstring

Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user If specified, teacher_id must be empty.

teacherIdstring

Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user If specified, student_id must be empty.

Response

Successful response

nextPageTokenstring

Token identifying the next page of results to return. If empty, no further results are available.

Changes

  • d9e82ce809f1Revision changes
    • info

      the security scope https://www.googleapis.com/auth/classroom.courses was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/classroom.courses was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/classroom.courses.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/classroom.courses.readonly was removed from the endpoint's security scheme Oauth2c

  • 8575901d0ec9Revision changes
    • info

      the security scope https://www.googleapis.com/auth/classroom.courses was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/classroom.courses was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/classroom.courses.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/classroom.courses.readonly was removed from the endpoint's security scheme Oauth2c