GitHub v3 REST API

Content Directory

array

A list of directory items

typestringrequired
sizeintegerrequired
namestringrequired
pathstringrequired
contentstring
shastringrequired
urlstring(uri)required
git_urlstring(uri)required
html_urlstring(uri)required
download_urlstring(uri)required
_linksobjectrequired
Show Child Parameters

Content File

object

Content File

typestringrequired
encodingstringrequired
sizeintegerrequired
namestringrequired
pathstringrequired
contentstringrequired
shastringrequired
urlstring(uri)required
git_urlstring(uri)required
html_urlstring(uri)required
download_urlstring(uri)required
_linksobjectrequired
Show Child Parameters
targetstring

Example:"actual/actual.md"

submodule_git_urlstring

Example:"git://example.com/defunkt/dotjs.git"

Example

Symlink Content

object

An object describing a symlink

typestringrequired
targetstringrequired
sizeintegerrequired
namestringrequired
pathstringrequired
shastringrequired
urlstring(uri)required
git_urlstring(uri)required
html_urlstring(uri)required
download_urlstring(uri)required
_linksobjectrequired
Show Child Parameters
Example

Symlink Content

object

An object describing a symlink

typestringrequired
submodule_git_urlstring(uri)required
sizeintegerrequired
namestringrequired
pathstringrequired
shastringrequired
urlstring(uri)required
git_urlstring(uri)required
html_urlstring(uri)required
download_urlstring(uri)required
_linksobjectrequired
Show Child Parameters
Example

File Commit

object

File Commit

contentobjectrequired
Show Child Parameters
commitobjectrequired
Show Child Parameters
Example