Get a classroom | GitHub API (unofficial showcase)

1 parameter

classroom_idintegerrequired

The unique identifier of the classroom to retrieve.

1 status code

410Returned when the operation is no longer available; the error object can include `message`, `documentation_url`, `url`, and `status`.

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 410 is returned because this operation is no longer available. The classroom_id path parameter identifies the classroom requested.

import { Client } from "@octridev/github";

const client = new Client({
  baseUrl: "https://api.github.com",
});

const result = await client.classrooms.get({ classroomId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" });

{
  "message": "This is an example message.",
  "documentation_url": "https://example.com",
  "url": "https://example.com",
  "status": "active"
}

Request

Response

Errors