Method: courses.aliases.list

Returns a list of aliases for a course.

This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to access the course or for access errors.
  • NOT_FOUND if the course does not exist.

HTTP request

GET https://classroom.googleapis.com/v1/courses/{courseId}/aliases

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
courseId

string

The identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

Query parameters

Parameters
pageSize

number

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

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

Response when listing course aliases.

JSON representation
{
  "aliases": [
    {
      object(CourseAlias)
    }
  ],
  "nextPageToken": string
}
Fields
aliases[]

object(CourseAlias)

The course aliases.

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 OAuth 2.0 Overview.

Try it!

Send feedback about...

Classroom API
Classroom API
Need help? Visit our support page.