List forks of a gist | GitHub API (unofficial showcase)

3 parameters

gist_idstringrequired

The unique identifier of the gist whose forks to list.

per_pageintegeroptional

Number of results per page, up to 100. Defaults to 30 when omitted.

Default:30

pageintegeroptional

Page number of the results to retrieve. Defaults to 1 when omitted.

Default:1

4 status codes

200Returns an array of forked gist objects.

forksarray<object>deprecatedoptional

historyarray<GistHistory>deprecatedoptional

fork_ofobjectoptional

Gist

urlstringoptional

forks_urlstringoptional

commits_urlstringoptional

idstringoptional

node_idstringoptional

git_pull_urlstringoptional

git_push_urlstringoptional

html_urlstringoptional

filesobjectoptional

publicbooleanoptional

created_atstringoptional

updated_atstringoptional

descriptionstringoptional

commentsintegeroptional

comments_enabledbooleanoptional

userstringoptional

comments_urlstringoptional

ownerobjectoptional

A GitHub user.

truncatedbooleanoptional

304Returned when the gist forks have not changed since the last request.

403Returned when the authenticated user is not permitted to access the gist forks.

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

404Returned when no gist exists with the given `gist_id`.

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 403 is returned when the authenticated user cannot access the gist. A 404 is returned when the gist_id path parameter does not identify an existing gist.

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

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

const result = await client.forks.list({
  gistId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
  perPage: 20,
  page: 1,
});

[
  {
    "url": "https://api.github.com/gists/aa5a315d61ae9438b18d",
    "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks",
    "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits",
    "id": "aa5a315d61ae9438b18d",
    "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk",
    "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
    "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
    "html_url": "https://gist.github.com/aa5a315d61ae9438b18d",
    "files": {
      "hello_world.rb": {
        "filename": "hello_world.rb",
        "type": "application/x-ruby",
        "language": "Ruby",
        "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb",
        "size": 167
      }
    },
    "public": true,
    "created_at": "2010-04-14T02:15:15Z",
    "updated_at": "2011-06-20T11:34:15Z",
    "description": "Hello World Examples",
    "comments": 1,
    "user": null,
    "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/",
    "owner": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "repos_url": "https://api.github.com/users/octocat/repos",
      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    }
  }
]

Request

Response

Errors