v56

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-011,4581,08113.3 MB

classroom

Closing down - Get an assignment

[!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.

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

get/assignments/{assignment_id}

Path parameters

assignment_idinteger required

The unique identifier of the classroom assignment.

Response

idinteger required

Unique identifier of the repository.

public_repoboolean required

Whether an accepted assignment creates a public repository.

titlestring required

Assignment title.

type'individual' | 'group' required

Whether it's a group assignment or individual assignment.

invite_linkstring required

The link that a student can use to accept the assignment.

invitations_enabledboolean required

Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment.

slugstring required

Sluggified name of the assignment.

students_are_repo_adminsboolean required

Whether students are admins on created repository when a student accepts the assignment.

feedback_pull_requests_enabledboolean required

Whether feedback pull request will be created when a student accepts the assignment.

max_teamsinteger nullable required

The maximum allowable teams for the assignment.

max_membersinteger nullable required

The maximum allowable members per team.

editorstring required

The selected editor for the assignment.

acceptedinteger required

The number of students that have accepted the assignment.

submittedinteger required

The number of students that have submitted the assignment.

passinginteger required

The number of students that have passed the assignment.

languagestring required

The programming language used in the assignment.

deadlinestring date-time nullable required

The time at which the assignment is due.

Example response

{
  "id": 42,
  "public_repo": true,
  "title": "Intro to Binaries",
  "type": "individual",
  "invite_link": "https://classroom.github.com/a/Lx7jiUgx",
  "invitations_enabled": true,
  "slug": "intro-to-binaries",
  "students_are_repo_admins": true,
  "feedback_pull_requests_enabled": true,
  "editor": "codespaces",
  "accepted": 25,
  "submitted": 10,
  "passing": 10,
  "language": "elixir",
  "deadline": "2011-01-26T19:06:43Z",
  "starter_code_repository": {
    "id": 1296269,
    "full_name": "octocat/Hello-World",
    "html_url": "https://github.com/octocat/Hello-World",
    "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
    "default_branch": "main"
  },
  "classroom": {
    "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"
  }
}