Sign in
classroom

Get a classroom

Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.

get/classrooms/{classroom_id}

Path parameters

classroom_idinteger required

The unique identifier of the classroom.

Response

Response

idinteger required

Unique identifier of the classroom.

namestring required

The name of the classroom.

archivedboolean required

Whether classroom is archived.

urlstring required

The URL of the classroom on GitHub Classroom.

Example response

{
  "id": 42,
  "name": "Programming Elixir",
  "organization": {
    "id": 1,
    "login": "github",
    "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
    "html_url": "https://github.com/github",
    "name": "Github - Code thigns happen here",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif"
  },
  "url": "https://classroom.github.com/classrooms/1-programming-elixir"
}

Changes