The REST API is now versioned.For more information, see "About API versioning."

REST API endpoints for gists

Use the REST API to list, create, update and delete the public gists on GitHub.

About gists

You can use the REST API to view and modify gists. For more information about gists, seeEditing and sharing content with gists.

You can read public gists anonymously, but you must be signed into GitHub to create gists. To read or write gists on a user's behalf, you need the gist OAuth scope and a token. For more information, seeScopes for OAuth apps.

Truncation

The API provides up to one megabyte of content for each file in the gist. Each file returned for a gist through the API has a key calledtruncated. Iftruncated istrue, the file is too large and only a portion of the contents were returned incontent.

If you need the full contents of the file, you can make aGET request to the URL specified byraw_url. Be aware that for files larger than ten megabytes, you'll need to clone the gist via the URL provided bygit_pull_url.

In addition to a specific file's contents being truncated, the entire files list may be truncated if the total number exceeds 300 files. If the top leveltruncated key istrue, only the first 300 files have been returned in the files list. If you need to fetch all of the gist's files, you'll need to clone the gist via the URL provided bygit_pull_url.

List gists for the authenticated user

Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:

Fine-grained access tokens for "List gists for the authenticated user"

This endpoint works with the following fine-grained token types:

The fine-grained token does not require any permissions.

Parameters for "List gists for the authenticated user"

Headers
Name, Type, Description
`accept`string Setting to`application/vnd.github+json` is recommended.

Query parameters
Name, Type, Description
`since`string Only show results that were last updated after the given time. This is a timestamp inISO 8601 format:`YYYY-MM-DDTHH:MM:SSZ`.
`per_page`integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default:`30`
`page`integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default:`1`

HTTP response status codes for "List gists for the authenticated user"

Status code	Description
`200`	OK
`304`	Not modified
`403`	Forbidden

Code samples for "List gists for the authenticated user"

Request example

get/gists

curl -L \  -H "Accept: application/vnd.github+json" \  -H "X-GitHub-Api-Version: 2022-11-28" \  https://api.github.com/gists

Response

Status: 200

[  {    "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": 0,    "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    },    "truncated": false  }]

Create a gist

Allows you to add a new gist with one or more files.

Note

Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.

Fine-grained access tokens for "Create a gist"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Gists" user permissions (write)

Parameters for "Create a gist"

Headers
Name, Type, Description
`accept`string Setting to`application/vnd.github+json` is recommended.

Name, Type, Description

descriptionstring

Description of the gist

filesobjectRequired

Names and content for the files that make up the gist

Properties offiles

Name, Type, Description

keyobject

A user-defined key to represent an item infiles.

Properties ofkey

Name, Type, Description
`content`stringRequired Content of the file

publicboolean or string

Flag indicating whether the gist is public

HTTP response status codes for "Create a gist"

Status code	Description
`201`	Created
`304`	Not modified
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Code samples for "Create a gist"

Request example

post/gists

curl -L \  -X POST \  -H "Accept: application/vnd.github+json" \  -H "Authorization: Bearer <YOUR-TOKEN>" \  -H "X-GitHub-Api-Version: 2022-11-28" \  https://api.github.com/gists \  -d '{"description":"Example of a gist","public":false,"files":{"README.md":{"content":"Hello World"}}}'

Response

Status: 201

{  "url": "https://api.github.com/gists/2decf6c462d9b4418f2",  "forks_url": "https://api.github.com/gists/2decf6c462d9b4418f2/forks",  "commits_url": "https://api.github.com/gists/2decf6c462d9b4418f2/commits",  "id": "2decf6c462d9b4418f2",  "node_id": "G_kwDOBhHyLdZDliNDQxOGYy",  "git_pull_url": "https://gist.github.com/2decf6c462d9b4418f2.git",  "git_push_url": "https://gist.github.com/2decf6c462d9b4418f2.git",  "html_url": "https://gist.github.com/2decf6c462d9b4418f2",  "files": {    "README.md": {      "filename": "README.md",      "type": "text/markdown",      "language": "Markdown",      "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md",      "size": 23,      "truncated": false,      "content": "Hello world from GitHub",      "encoding": "utf-8"    }  },  "public": true,  "created_at": "2022-09-20T12:11:58Z",  "updated_at": "2022-09-21T10:28:06Z",  "description": "An updated gist description.",  "comments": 0,  "comments_enabled": true,  "user": null,  "comments_url": "https://api.github.com/gists/2decf6c462d9b4418f2/comments",  "owner": {    "login": "monalisa",    "id": 104456405,    "node_id": "U_kgDOBhHyLQ",    "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4",    "gravatar_id": "",    "url": "https://api.github.com/users/monalisa",    "html_url": "https://github.com/monalisa",    "followers_url": "https://api.github.com/users/monalisa/followers",    "following_url": "https://api.github.com/users/monalisa/following{/other_user}",    "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",    "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",    "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",    "organizations_url": "https://api.github.com/users/monalisa/orgs",    "repos_url": "https://api.github.com/users/monalisa/repos",    "events_url": "https://api.github.com/users/monalisa/events{/privacy}",    "received_events_url": "https://api.github.com/users/monalisa/received_events",    "type": "User",    "site_admin": true  },  "forks": [],  "history": [    {      "user": {        "login": "monalisa",        "id": 104456405,        "node_id": "U_kgyLQ",        "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4",        "gravatar_id": "",        "url": "https://api.github.com/users/monalisa",        "html_url": "https://github.com/monalisa",        "followers_url": "https://api.github.com/users/monalisa/followers",        "following_url": "https://api.github.com/users/monalisa/following{/other_user}",        "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",        "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",        "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",        "organizations_url": "https://api.github.com/users/monalisa/orgs",        "repos_url": "https://api.github.com/users/monalisa/repos",        "events_url": "https://api.github.com/users/monalisa/events{/privacy}",        "received_events_url": "https://api.github.com/users/monalisa/received_events",        "type": "User",        "site_admin": true      },      "version": "468aac8caed5f0c3b859b8286968",      "committed_at": "2022-09-21T10:28:06Z",      "change_status": {        "total": 2,        "additions": 1,        "deletions": 1      },      "url": "https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968"    }  ],  "truncated": false}

List public gists

List public gists sorted by most recently updated to least recently updated.

Note: Withpagination, you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.

Fine-grained access tokens for "List public gists"

This endpoint works with the following fine-grained token types:

The fine-grained token does not require any permissions.

Parameters for "List public gists"

Headers
Name, Type, Description
`accept`string Setting to`application/vnd.github+json` is recommended.

Query parameters
Name, Type, Description
`since`string Only show results that were last updated after the given time. This is a timestamp inISO 8601 format:`YYYY-MM-DDTHH:MM:SSZ`.
`per_page`integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default:`30`
`page`integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default:`1`

HTTP response status codes for "List public gists"

Status code	Description
`200`	OK
`304`	Not modified
`403`	Forbidden
`422`	Validation failed, or the endpoint has been spammed.

Code samples for "List public gists"

Request example

get/gists/public

curl -L \  -H "Accept: application/vnd.github+json" \  -H "X-GitHub-Api-Version: 2022-11-28" \  https://api.github.com/gists/public

Response

Status: 200

[  {    "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": 0,    "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    },    "truncated": false  }]

List starred gists

List the authenticated user's starred gists:

Fine-grained access tokens for "List starred gists"

This endpoint works with the following fine-grained token types:

The fine-grained token does not require any permissions.

Parameters for "List starred gists"

Headers
Name, Type, Description
`accept`string Setting to`application/vnd.github+json` is recommended.

Query parameters
Name, Type, Description
`since`string Only show results that were last updated after the given time. This is a timestamp inISO 8601 format:`YYYY-MM-DDTHH:MM:SSZ`.
`per_page`integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default:`30`
`page`integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default:`1`

HTTP response status codes for "List starred gists"

Status code	Description
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden

Code samples for "List starred gists"

Request example

get/gists/starred

curl -L \  -H "Accept: application/vnd.github+json" \  -H "X-GitHub-Api-Version: 2022-11-28" \  https://api.github.com/gists/starred

Response

Status: 200

[  {    "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": 0,    "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    },    "truncated": false  }]

Get a gist

Gets a specified gist.

This endpoint supports the following custom media types. For more information, see "Media types."

application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.

Fine-grained access tokens for "Get a gist"

This endpoint works with the following fine-grained token types:

The fine-grained token does not require any permissions.

Parameters for "Get a gist"

Headers
Name, Type, Description
`accept`string Setting to`application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`gist_id`stringRequired The unique identifier of the gist.

HTTP response status codes for "Get a gist"

Status code	Description
`200`	OK
`304`	Not modified
`403`	Forbidden Gist
`404`	Resource not found

Code samples for "Get a gist"

Request example

get/gists/{gist_id}

curl -L \  -H "Accept: application/vnd.github+json" \  -H "X-GitHub-Api-Version: 2022-11-28" \  https://api.github.com/gists/GIST_ID

Response

Status: 200

{  "url": "https://api.github.com/gists/2decf6c462d9b4418f2",  "forks_url": "https://api.github.com/gists/2decf6c462d9b4418f2/forks",  "commits_url": "https://api.github.com/gists/2decf6c462d9b4418f2/commits",  "id": "2decf6c462d9b4418f2",  "node_id": "G_kwDOBhHyLdZDliNDQxOGYy",  "git_pull_url": "https://gist.github.com/2decf6c462d9b4418f2.git",  "git_push_url": "https://gist.github.com/2decf6c462d9b4418f2.git",  "html_url": "https://gist.github.com/2decf6c462d9b4418f2",  "files": {    "README.md": {      "filename": "README.md",      "type": "text/markdown",      "language": "Markdown",      "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md",      "size": 23,      "truncated": false,      "content": "Hello world from GitHub",      "encoding": "utf-8"    }  },  "public": true,  "created_at": "2022-09-20T12:11:58Z",  "updated_at": "2022-09-21T10:28:06Z",  "description": "An updated gist description.",  "comments": 0,  "comments_enabled": true,  "user": null,  "comments_url": "https://api.github.com/gists/2decf6c462d9b4418f2/comments",  "owner": {    "login": "monalisa",    "id": 104456405,    "node_id": "U_kgDOBhHyLQ",    "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4",    "gravatar_id": "",    "url": "https://api.github.com/users/monalisa",    "html_url": "https://github.com/monalisa",    "followers_url": "https://api.github.com/users/monalisa/followers",    "following_url": "https://api.github.com/users/monalisa/following{/other_user}",    "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",    "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",    "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",    "organizations_url": "https://api.github.com/users/monalisa/orgs",    "repos_url": "https://api.github.com/users/monalisa/repos",    "events_url": "https://api.github.com/users/monalisa/events{/privacy}",    "received_events_url": "https://api.github.com/users/monalisa/received_events",    "type": "User",    "site_admin": true  },  "forks": [],  "history": [    {      "user": {        "login": "monalisa",        "id": 104456405,        "node_id": "U_kgyLQ",        "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4",        "gravatar_id": "",        "url": "https://api.github.com/users/monalisa",        "html_url": "https://github.com/monalisa",        "followers_url": "https://api.github.com/users/monalisa/followers",        "following_url": "https://api.github.com/users/monalisa/following{/other_user}",        "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",        "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",        "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",        "organizations_url": "https://api.github.com/users/monalisa/orgs",        "repos_url": "https://api.github.com/users/monalisa/repos",        "events_url": "https://api.github.com/users/monalisa/events{/privacy}",        "received_events_url": "https://api.github.com/users/monalisa/received_events",        "type": "User",        "site_admin": true      },      "version": "468aac8caed5f0c3b859b8286968",      "committed_at": "2022-09-21T10:28:06Z",      "change_status": {        "total": 2,        "additions": 1,        "deletions": 1      },      "url": "https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968"    }  ],  "truncated": false}

Update a gist

Allows you to update a gist's description and to update, delete, or rename gist files. Filesfrom the previous version of the gist that aren't explicitly changed during an editare unchanged.

At least one ofdescription orfiles is required.

This endpoint supports the following custom media types. For more information, see "Media types."

application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.

Fine-grained access tokens for "Update a gist"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Gists" user permissions (write)

Parameters for "Update a gist"

Headers
Name, Type, Description
`accept`string Setting to`application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`gist_id`stringRequired The unique identifier of the gist.

Name, Type, Description

descriptionstring

The description of the gist.

filesobject

The gist files to be updated, renamed, or deleted. Eachkey must match the current filename(including extension) of the targeted gist file. For example:hello.py.

To delete a file, set the whole file to null. For example:hello.py : null. The file will also bedeleted if the specified object does not contain at least one ofcontent orfilename.

Properties offiles

Name, Type, Description

keyobject

A user-defined key to represent an item infiles.

Properties ofkey

Name, Type, Description
`content`string The new content of the file.
`filename`string or null The new filename for the file.

HTTP response status codes for "Update a gist"

Status code	Description
`200`	OK
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Code samples for "Update a gist"

Request examples

Select the example type

patch/gists/{gist_id}

curl -L \  -X PATCH \  -H "Accept: application/vnd.github+json" \  -H "Authorization: Bearer <YOUR-TOKEN>" \  -H "X-GitHub-Api-Version: 2022-11-28" \  https://api.github.com/gists/GIST_ID \  -d '{"description":"An updated gist description","files":{"README.md":{"content":"Hello World from GitHub"}}}'

Response

Status: 200

{  "url": "https://api.github.com/gists/2decf6c462d9b4418f2",  "forks_url": "https://api.github.com/gists/2decf6c462d9b4418f2/forks",  "commits_url": "https://api.github.com/gists/2decf6c462d9b4418f2/commits",  "id": "2decf6c462d9b4418f2",  "node_id": "G_kwDOBhHyLdZDliNDQxOGYy",  "git_pull_url": "https://gist.github.com/2decf6c462d9b4418f2.git",  "git_push_url": "https://gist.github.com/2decf6c462d9b4418f2.git",  "html_url": "https://gist.github.com/2decf6c462d9b4418f2",  "files": {    "README.md": {      "filename": "README.md",      "type": "text/markdown",      "language": "Markdown",      "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md",      "size": 23,      "truncated": false,      "content": "Hello world from GitHub",      "encoding": "utf-8"    }  },  "public": true,  "created_at": "2022-09-20T12:11:58Z",  "updated_at": "2022-09-21T10:28:06Z",  "description": "An updated gist description.",  "comments": 0,  "comments_enabled": true,  "user": null,  "comments_url": "https://api.github.com/gists/2decf6c462d9b4418f2/comments",  "owner": {    "login": "monalisa",    "id": 104456405,    "node_id": "U_kgDOBhHyLQ",    "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4",    "gravatar_id": "",    "url": "https://api.github.com/users/monalisa",    "html_url": "https://github.com/monalisa",    "followers_url": "https://api.github.com/users/monalisa/followers",    "following_url": "https://api.github.com/users/monalisa/following{/other_user}",    "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",    "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",    "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",    "organizations_url": "https://api.github.com/users/monalisa/orgs",    "repos_url": "https://api.github.com/users/monalisa/repos",    "events_url": "https://api.github.com/users/monalisa/events{/privacy}",    "received_events_url": "https://api.github.com/users/monalisa/received_events",    "type": "User",    "site_admin": true  },  "forks": [],  "history": [    {      "user": {        "login": "monalisa",        "id": 104456405,        "node_id": "U_kgyLQ",        "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4",        "gravatar_id": "",        "url": "https://api.github.com/users/monalisa",        "html_url": "https://github.com/monalisa",        "followers_url": "https://api.github.com/users/monalisa/followers",        "following_url": "https://api.github.com/users/monalisa/following{/other_user}",        "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",        "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",        "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",        "organizations_url": "https://api.github.com/users/monalisa/orgs",        "repos_url": "https://api.github.com/users/monalisa/repos",        "events_url": "https://api.github.com/users/monalisa/events{/privacy}",        "received_events_url": "https://api.github.com/users/monalisa/received_events",        "type": "User",        "site_admin": true      },      "version": "468aac8caed5f0c3b859b8286968",      "committed_at": "2022-09-21T10:28:06Z",      "change_status": {        "total": 2,        "additions": 1,        "deletions": 1      },      "url": "https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968"    }  ],  "truncated": false}

Delete a gist

Fine-grained access tokens for "Delete a gist"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Gists" user permissions (write)

Parameters for "Delete a gist"

Headers
Name, Type, Description
`accept`string Setting to`application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`gist_id`stringRequired The unique identifier of the gist.

HTTP response status codes for "Delete a gist"

Status code	Description
`204`	No Content
`304`	Not modified
`403`	Forbidden
`404`	Resource not found

Code samples for "Delete a gist"

Request example

delete/gists/{gist_id}

curl -L \  -X DELETE \  -H "Accept: application/vnd.github+json" \  -H "Authorization: Bearer <YOUR-TOKEN>" \  -H "X-GitHub-Api-Version: 2022-11-28" \  https://api.github.com/gists/GIST_ID

Response

Status: 204

Headers
Name, Type, Description
`accept`string Setting to`application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`gist_id`stringRequired The unique identifier of the gist.

Query parameters
Name, Type, Description
`per_page`integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default:`30`
`page`integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default:`1`

HTTP response status codes for "List gist commits"

Status code	Description
`200`	OK
`304`	Not modified
`403`	Forbidden
`404`	Resource not found

Code samples for "List gist commits"

Request example

get/gists/{gist_id}/commits

curl -L \  -H "Accept: application/vnd.github+json" \  -H "X-GitHub-Api-Version: 2022-11-28" \  https://api.github.com/gists/GIST_ID/commits

Response

Status: 200

[  {    "url": "https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f",    "version": "57a7f021a713b1c5a6a199b54cc514735d2d462f",    "user": {      "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    },    "change_status": {      "deletions": 0,      "additions": 180,      "total": 180    },    "committed_at": "2010-04-14T02:15:15Z"  }]

Headers
Name, Type, Description
`accept`string Setting to`application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`gist_id`stringRequired The unique identifier of the gist.

Query parameters
Name, Type, Description
`per_page`integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default:`30`
`page`integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default:`1`

HTTP response status codes for "List gist forks"

Status code	Description
`200`	OK
`304`	Not modified
`403`	Forbidden
`404`	Resource not found

Code samples for "List gist forks"

Request example

get/gists/{gist_id}/forks

curl -L \  -H "Accept: application/vnd.github+json" \  -H "X-GitHub-Api-Version: 2022-11-28" \  https://api.github.com/gists/GIST_ID/forks

Response

Status: 200

[  {    "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    }  }]

Fork a gist

Fine-grained access tokens for "Fork a gist"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Gists" user permissions (write)

Parameters for "Fork a gist"

Headers
Name, Type, Description
`accept`string Setting to`application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`gist_id`stringRequired The unique identifier of the gist.

HTTP response status codes for "Fork a gist"

Status code	Description
`201`	Created
`304`	Not modified
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Code samples for "Fork a gist"

Request example

post/gists/{gist_id}/forks

curl -L \  -X POST \  -H "Accept: application/vnd.github+json" \  -H "Authorization: Bearer <YOUR-TOKEN>" \  -H "X-GitHub-Api-Version: 2022-11-28" \  https://api.github.com/gists/GIST_ID/forks

Response

Status: 201

{  "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": 0,  "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  },  "truncated": false}

Headers
Name, Type, Description
`accept`string Setting to`application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`gist_id`stringRequired The unique identifier of the gist.

HTTP response status codes for "Check if a gist is starred"

Status code	Description
`204`	Response if gist is starred
`304`	Not modified
`403`	Forbidden
`404`	Not Found if gist is not starred

Code samples for "Check if a gist is starred"

Request example

get/gists/{gist_id}/star

curl -L \  -H "Accept: application/vnd.github+json" \  -H "X-GitHub-Api-Version: 2022-11-28" \  https://api.github.com/gists/GIST_ID/star

Response if gist is starred

Status: 204

Star a gist

Note that you'll need to setContent-Length to zero when calling out to this endpoint. For more information, see "HTTP method."

Fine-grained access tokens for "Star a gist"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Gists" user permissions (write)

Parameters for "Star a gist"

Headers
Name, Type, Description
`accept`string Setting to`application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`gist_id`stringRequired The unique identifier of the gist.

HTTP response status codes for "Star a gist"

Status code	Description
`204`	No Content
`304`	Not modified
`403`	Forbidden
`404`	Resource not found

Code samples for "Star a gist"

Request example

put/gists/{gist_id}/star

curl -L \  -X PUT \  -H "Accept: application/vnd.github+json" \  -H "Authorization: Bearer <YOUR-TOKEN>" \  -H "X-GitHub-Api-Version: 2022-11-28" \  https://api.github.com/gists/GIST_ID/star

Response

Status: 204

Unstar a gist

Fine-grained access tokens for "Unstar a gist"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Gists" user permissions (write)

Parameters for "Unstar a gist"

Headers
Name, Type, Description
`accept`string Setting to`application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`gist_id`stringRequired The unique identifier of the gist.

HTTP response status codes for "Unstar a gist"

Status code	Description
`204`	No Content
`304`	Not modified
`403`	Forbidden
`404`	Resource not found

Code samples for "Unstar a gist"

Request example

delete/gists/{gist_id}/star

curl -L \  -X DELETE \  -H "Accept: application/vnd.github+json" \  -H "Authorization: Bearer <YOUR-TOKEN>" \  -H "X-GitHub-Api-Version: 2022-11-28" \  https://api.github.com/gists/GIST_ID/star

Response

Status: 204

Get a gist revision

Gets a specified gist revision.

This endpoint supports the following custom media types. For more information, see "Media types."

application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.

Fine-grained access tokens for "Get a gist revision"

This endpoint works with the following fine-grained token types:

The fine-grained token does not require any permissions.

Parameters for "Get a gist revision"

Headers
Name, Type, Description
`accept`string Setting to`application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`gist_id`stringRequired The unique identifier of the gist.
`sha`stringRequired

HTTP response status codes for "Get a gist revision"

Status code	Description
`200`	OK
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Code samples for "Get a gist revision"

Request example

get/gists/{gist_id}/{sha}

curl -L \  -H "Accept: application/vnd.github+json" \  -H "X-GitHub-Api-Version: 2022-11-28" \  https://api.github.com/gists/GIST_ID/SHA

Response

Status: 200

{  "url": "https://api.github.com/gists/2decf6c462d9b4418f2",  "forks_url": "https://api.github.com/gists/2decf6c462d9b4418f2/forks",  "commits_url": "https://api.github.com/gists/2decf6c462d9b4418f2/commits",  "id": "2decf6c462d9b4418f2",  "node_id": "G_kwDOBhHyLdZDliNDQxOGYy",  "git_pull_url": "https://gist.github.com/2decf6c462d9b4418f2.git",  "git_push_url": "https://gist.github.com/2decf6c462d9b4418f2.git",  "html_url": "https://gist.github.com/2decf6c462d9b4418f2",  "files": {    "README.md": {      "filename": "README.md",      "type": "text/markdown",      "language": "Markdown",      "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md",      "size": 23,      "truncated": false,      "content": "Hello world from GitHub",      "encoding": "utf-8"    }  },  "public": true,  "created_at": "2022-09-20T12:11:58Z",  "updated_at": "2022-09-21T10:28:06Z",  "description": "An updated gist description.",  "comments": 0,  "comments_enabled": true,  "user": null,  "comments_url": "https://api.github.com/gists/2decf6c462d9b4418f2/comments",  "owner": {    "login": "monalisa",    "id": 104456405,    "node_id": "U_kgDOBhHyLQ",    "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4",    "gravatar_id": "",    "url": "https://api.github.com/users/monalisa",    "html_url": "https://github.com/monalisa",    "followers_url": "https://api.github.com/users/monalisa/followers",    "following_url": "https://api.github.com/users/monalisa/following{/other_user}",    "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",    "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",    "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",    "organizations_url": "https://api.github.com/users/monalisa/orgs",    "repos_url": "https://api.github.com/users/monalisa/repos",    "events_url": "https://api.github.com/users/monalisa/events{/privacy}",    "received_events_url": "https://api.github.com/users/monalisa/received_events",    "type": "User",    "site_admin": true  },  "forks": [],  "history": [    {      "user": {        "login": "monalisa",        "id": 104456405,        "node_id": "U_kgyLQ",        "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4",        "gravatar_id": "",        "url": "https://api.github.com/users/monalisa",        "html_url": "https://github.com/monalisa",        "followers_url": "https://api.github.com/users/monalisa/followers",        "following_url": "https://api.github.com/users/monalisa/following{/other_user}",        "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",        "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",        "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",        "organizations_url": "https://api.github.com/users/monalisa/orgs",        "repos_url": "https://api.github.com/users/monalisa/repos",        "events_url": "https://api.github.com/users/monalisa/events{/privacy}",        "received_events_url": "https://api.github.com/users/monalisa/received_events",        "type": "User",        "site_admin": true      },      "version": "468aac8caed5f0c3b859b8286968",      "committed_at": "2022-09-21T10:28:06Z",      "change_status": {        "total": 2,        "additions": 1,        "deletions": 1      },      "url": "https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968"    }  ],  "truncated": false}

Headers
Name, Type, Description
`accept`string Setting to`application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`username`stringRequired The handle for the GitHub user account.

Query parameters
Name, Type, Description
`since`string Only show results that were last updated after the given time. This is a timestamp inISO 8601 format:`YYYY-MM-DDTHH:MM:SSZ`.
`per_page`integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default:`30`
`page`integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default:`1`

HTTP response status codes for "List gists for a user"

Status code	Description
`200`	OK
`422`	Validation failed, or the endpoint has been spammed.

Code samples for "List gists for a user"

Request example

get/users/{username}/gists

curl -L \  -H "Accept: application/vnd.github+json" \  -H "X-GitHub-Api-Version: 2022-11-28" \  https://api.github.com/users/USERNAME/gists

Response

Status: 200

[  {    "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": 0,    "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    },    "truncated": false  }]

Movatterモバイル変換

REST API endpoints for gists

Request example

Response

Request example

Response

Request example

Response

Request example

Response

Request example

Response

Request examples

Response

Request example

Response

Request example

Response

Request example

Response

Request example

Response

Request example

Response if gist is starred

Request example

Response

Request example

Response

Request example

Response

Request example

Response