Method: courses.list

    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.

    HTTP request

    GET https://classroom.googleapis.com/v1/courses

    The URL uses gRPC Transcoding syntax.

    Query parameters

    Parameters
    studentId

    string

    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
    teacherId

    string

    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
    courseStates[]

    enum ( CourseState )

    Restricts returned courses to those in one of the specified states The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.

    pageSize

    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.

    pageToken

    string

    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.

    Request body

    The request body must be empty.

    Response body

    Response when listing courses.

    If successful, the response body contains data with the following structure:

    JSON representation 
     { 
 "courses" 
 : 
 [ 
 { 
 object (  Course 
 
) 
 } 
 ] 
 , 
 "nextPageToken" 
 : 
 string 
 }
    Fields
    courses[]

    object ( Course )

    Courses that match the list request.
    nextPageToken

    string

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

    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 .
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: