Skip to content
forgit api docs

Closing down - List classrooms

Deprecated
GET
/classrooms

[!WARNING] Closing down notice: This operation is closing down and will be removed on August 28, 2026. For more information, see the GitHub Classroom sunset notice.

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.

API method documentation

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “ Query Parameters ”
page
integer
default: 1

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

per_page
integer
default: 30

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

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Response

Media type application/json
Array<object>
Simple Classroom

A GitHub Classroom classroom

object
id
required

Unique identifier of the classroom.

integer
name
required

The name of the classroom.

string
archived
required

Returns whether classroom is archived or not.

boolean
url
required

The url of the classroom on GitHub Classroom.

string
Examples
Example default 
{
  "id": 1296269,
  "name": "Programming Elixir",
  "archived": "false,",
  "url": "https://classroom.github.com/classrooms/1-programming-elixir"
}

410

Section titled “ 410 ”

Gone

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}