Get a gist

GET/gists/{gist_id}

Source: github-v3-rest.json
Revision: f5f067c1e6f6
Active snapshot: 85e53e3d0d65

Request

Path Parameters

gist_id string required: gist_id parameter

Responses

application/json Gist Simple object

Response

comments integer

optional

comments_url string

optional

commits_url string

optional

created_at string

optional

description string

optionalnullable

files object

optional

fork_of Gist object

optionalnullable

Gist

comments integer

required

comments_url string<uri>

required

commits_url string<uri>

required

created_at string<date-time>

required

description string

requirednullable

files object

required

forks array

optional

forks_url string<uri>

required

git_pull_url string<uri>

required

git_push_url string<uri>

required

history array

optional

html_url string<uri>

required

id string

required

node_id string

required

owner Simple User object

optionalnullable

Simple User

avatar_url string<uri>

required

Example: https://github.com/images/error/octocat_happy.gif

email string

optionalnullable

events_url string

required

Example: https://api.github.com/users/octocat/events{/privacy}

followers_url string<uri>

required

Example: https://api.github.com/users/octocat/followers

following_url string

required

Example: https://api.github.com/users/octocat/following{/other_user}

gists_url string

required

Example: https://api.github.com/users/octocat/gists{/gist_id}

gravatar_id string

requirednullable

Example: 41d064eb2195891e12d0413f63227ea7

html_url string<uri>

required

Example: https://github.com/octocat

id integer

required

Example: 1

required

Example: octocat

name string

optionalnullable

node_id string

required

Example: MDQ6VXNlcjE=

organizations_url string<uri>

required

Example: https://api.github.com/users/octocat/orgs

received_events_url string<uri>

required

Example: https://api.github.com/users/octocat/received_events

repos_url string<uri>

required

Example: https://api.github.com/users/octocat/repos

site_admin boolean

required

starred_at string

optional

Example: "2020-07-09T00:17:55Z"

starred_url string

required

Example: https://api.github.com/users/octocat/starred{/owner}{/repo}

subscriptions_url string<uri>

required

Example: https://api.github.com/users/octocat/subscriptions

type string

required

Example: User

url string<uri>

required

Example: https://api.github.com/users/octocat

public boolean

required

truncated boolean

optional

updated_at string<date-time>

required

url string<uri>

required

user Simple User object

requirednullable

Simple User

avatar_url string<uri>

required

Example: https://github.com/images/error/octocat_happy.gif

email string

optionalnullable

events_url string

required

Example: https://api.github.com/users/octocat/events{/privacy}

followers_url string<uri>

required

Example: https://api.github.com/users/octocat/followers

following_url string

required

Example: https://api.github.com/users/octocat/following{/other_user}

gists_url string

required

Example: https://api.github.com/users/octocat/gists{/gist_id}

gravatar_id string

requirednullable

Example: 41d064eb2195891e12d0413f63227ea7

html_url string<uri>

required

Example: https://github.com/octocat

id integer

required

Example: 1

required

Example: octocat

name string

optionalnullable

node_id string

required

Example: MDQ6VXNlcjE=

organizations_url string<uri>

required

Example: https://api.github.com/users/octocat/orgs

received_events_url string<uri>

required

Example: https://api.github.com/users/octocat/received_events

repos_url string<uri>

required

Example: https://api.github.com/users/octocat/repos

site_admin boolean

required

starred_at string

optional

Example: "2020-07-09T00:17:55Z"

starred_url string

required

Example: https://api.github.com/users/octocat/starred{/owner}{/repo}

subscriptions_url string<uri>

required

Example: https://api.github.com/users/octocat/subscriptions

type string

required

Example: User

url string<uri>

required

Example: https://api.github.com/users/octocat

forks array[object]

optionalnullable deprecated

items object

created_at string<date-time>

optional

id string

optional

updated_at string<date-time>

optional

url string<uri>

optional

user Public User object

optional

Public User

avatar_url string<uri>

required

bio string

requirednullable

blog string

requirednullable

collaborators integer

optional

Example: 3

company string

requirednullable

created_at string<date-time>

required

disk_usage integer

optional

Example: 1

email string<email>

requirednullable

events_url string

required

followers integer

required

followers_url string<uri>

required

following integer

required

following_url string

required

gists_url string

required

gravatar_id string

requirednullable

hireable boolean

requirednullable

html_url string<uri>

required

id integer

required

location string

requirednullable

required

name string

requirednullable

node_id string

required

organizations_url string<uri>

required

owned_private_repos integer

optional

Example: 2

plan object

optional

private_gists integer

optional

Example: 1

public_gists integer

required

public_repos integer

required

received_events_url string<uri>

required

repos_url string<uri>

required

site_admin boolean

required

starred_url string

required

subscriptions_url string<uri>

required

suspended_at string<date-time>

optionalnullable

total_private_repos integer

optional

Example: 2

type string

required

updated_at string<date-time>

required

url string<uri>

required

forks_url string

optional

git_pull_url string

optional

git_push_url string

optional

history array[Gist History object]

optionalnullable deprecated

items Gist History object

Gist History

change_status object

optional

additions integer

optional

deletions integer

optional

total integer

optional

committed_at string<date-time>

optional

url string<uri>

optional

user Simple User object

optionalnullable

Simple User

avatar_url string<uri>

required

Example: https://github.com/images/error/octocat_happy.gif

email string

optionalnullable

events_url string

required

Example: https://api.github.com/users/octocat/events{/privacy}

followers_url string<uri>

required

Example: https://api.github.com/users/octocat/followers

following_url string

required

Example: https://api.github.com/users/octocat/following{/other_user}

gists_url string

required

Example: https://api.github.com/users/octocat/gists{/gist_id}

gravatar_id string

requirednullable

Example: 41d064eb2195891e12d0413f63227ea7

html_url string<uri>

required

Example: https://github.com/octocat

id integer

required

Example: 1

required

Example: octocat

name string

optionalnullable

node_id string

required

Example: MDQ6VXNlcjE=

organizations_url string<uri>

required

Example: https://api.github.com/users/octocat/orgs

received_events_url string<uri>

required

Example: https://api.github.com/users/octocat/received_events

repos_url string<uri>

required

Example: https://api.github.com/users/octocat/repos

site_admin boolean

required

starred_at string

optional

Example: "2020-07-09T00:17:55Z"

starred_url string

required

Example: https://api.github.com/users/octocat/starred{/owner}{/repo}

subscriptions_url string<uri>

required

Example: https://api.github.com/users/octocat/subscriptions

type string

required

Example: User

url string<uri>

required

Example: https://api.github.com/users/octocat

version string

optional

html_url string

optional

id string

optional

node_id string

optional

owner Simple User object

optional

Simple User

avatar_url string<uri>

required

Example: https://github.com/images/error/octocat_happy.gif

email string

optionalnullable

events_url string

required

Example: https://api.github.com/users/octocat/events{/privacy}

followers_url string<uri>

required

Example: https://api.github.com/users/octocat/followers

following_url string

required

Example: https://api.github.com/users/octocat/following{/other_user}

gists_url string

required

Example: https://api.github.com/users/octocat/gists{/gist_id}

gravatar_id string

requirednullable

Example: 41d064eb2195891e12d0413f63227ea7

html_url string<uri>

required

Example: https://github.com/octocat

id integer

required

Example: 1

required

Example: octocat

name string

optionalnullable

node_id string

required

Example: MDQ6VXNlcjE=

organizations_url string<uri>

required

Example: https://api.github.com/users/octocat/orgs

received_events_url string<uri>

required

Example: https://api.github.com/users/octocat/received_events

repos_url string<uri>

required

Example: https://api.github.com/users/octocat/repos

site_admin boolean

required

starred_at string

optional

Example: "2020-07-09T00:17:55Z"

starred_url string

required

Example: https://api.github.com/users/octocat/starred{/owner}{/repo}

subscriptions_url string<uri>

required

Example: https://api.github.com/users/octocat/subscriptions

type string

required

Example: User

url string<uri>

required

Example: https://api.github.com/users/octocat

public boolean

optional

truncated boolean

optional

updated_at string

optional

url string

optional

user string

optionalnullable

Response Example: 200 application/json

{
  "comments": 0,
  "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/",
  "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits",
  "created_at": "2010-04-14T02:15:15Z",
  "description": "Hello World Examples",
  "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks",
  "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",
  "id": "aa5a315d61ae9438b18d",
  "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk",
  "updated_at": "2011-06-20T11:34:15Z",
  "url": "https://api.github.com/gists/aa5a315d61ae9438b18d"
}

Not modified

application/json object

Forbidden Gist

block object

optional

created_at string

optional

html_url string

optionalnullable

reason string

optional

documentation_url string

optional

message string

optional

application/json Basic Error object

Resource not found

documentation_url string

optional

message string

optional

status string

optional

url string

optional

Request configuration

This OpenAPI document does not declare an authentication scheme. Check the API provider's documentation before sending credentials; Manja cannot infer or validate an undocumented scheme.

Common bearer example: Authorization: Bearer YOUR_ACCESS_TOKEN

hostname

Self-hosted Enterprise Server or Enterprise Cloud hostname

protocol

Self-hosted Enterprise Server or Enterprise Cloud protocol

gist_id *

gist_id parameter

Request Sample: Shell / cURL

curl --request GET \
  --url {protocol}://{hostname}/api/v3/gists/{gist_id}