Sign in
classroom

List classrooms

Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.

get/classrooms

Query parameters

pageinteger

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

per_pageinteger

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Response

Response

idinteger required

Unique identifier of the classroom.

namestring required

The name of the classroom.

archivedboolean required

Returns whether classroom is archived or not.

urlstring required

The url of the classroom on GitHub Classroom.

Example response

[
  {
    "id": 42,
    "name": "Programming Elixir",
    "url": "https://classroom.github.com/classrooms/1-programming-elixir"
  }
]

Changes