Search
K
GitHub v3 REST API

Check if a gist is starred

get
{protocol}://{hostname}/api/v3/gists/{gist_id}/star

Path Parameters

gist_idstringrequired

gist_id parameter

Response

Response if gist is starred

get/gists/{gist_id}/star
 

Star a gist

Note that you’ll need to set Content-Length to zero when calling out to this endpoint. For more information, see “HTTP verbs.”

put
{protocol}://{hostname}/api/v3/gists/{gist_id}/star

Path Parameters

gist_idstringrequired

gist_id parameter

Response

Response

put/gists/{gist_id}/star
 

Unstar a gist

delete
{protocol}://{hostname}/api/v3/gists/{gist_id}/star

Path Parameters

gist_idstringrequired

gist_id parameter

Response

Response

delete/gists/{gist_id}/star
 

Get a gist revision

get
{protocol}://{hostname}/api/v3/gists/{gist_id}/{sha}

Path Parameters

gist_idstringrequired

gist_id parameter

shastringrequired

Response

application/json

Response

Gist Simple

Gist Simple

forksarray | null[object]DEPRECATED
Show Child Parameters
historyarray | null[object]DEPRECATED

Gist History

Show Child Parameters
fork_ofobject | null

Gist

Show Child Parameters
urlstring
forks_urlstring
commits_urlstring
idstring
node_idstring
git_pull_urlstring
git_push_urlstring
html_urlstring
filesobject
publicboolean
created_atstring
updated_atstring
descriptionstring | null
commentsinteger
userstring | null
comments_urlstring
ownerobject

Simple User

Show Child Parameters
truncatedboolean
get/gists/{gist_id}/{sha}
 
application/json

List gists for a user

Lists public gists for the specified user:

get
{protocol}://{hostname}/api/v3/users/{username}/gists

Query Parameters

sincestring(date-time)

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

per_pageinteger

Results per page (max 100)

Default:30

pageinteger

Page number of the results to fetch.

Default:1

Path Parameters

usernamestringrequired

Response

application/json

Response

Base Gist

urlstring(uri)required
forks_urlstring(uri)required
commits_urlstring(uri)required
idstringrequired
node_idstringrequired
git_pull_urlstring(uri)required
git_push_urlstring(uri)required
html_urlstring(uri)required
filesobjectrequired
publicbooleanrequired
created_atstring(date-time)required
updated_atstring(date-time)required
descriptionstring | nullrequired
commentsintegerrequired
userobject | nullrequired

Simple User

Show Child Parameters
comments_urlstring(uri)required
ownerobject

Simple User

Show Child Parameters
truncatedboolean
forksarray
historyarray
get/users/{username}/gists
 
application/json