Skip to main content

Get repository content

Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit `:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. Files and symlinks support [a custom media type](https://docs.github.com/[email protected]/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML (when supported). All content types support [a custom media type](https://docs.github.com/[email protected]/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent object format. **Note**: * To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/[email protected]/rest/reference/git#trees). * This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees API](https://docs.github.com/[email protected]/rest/reference/git#get-a-tree). * This API supports files up to 1 megabyte in size. #### If the content is a directory The response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule". #### If the content is a symlink If the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the API responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object describing the symlink itself. #### If the content is a submodule The `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values.

GET/repos/{owner}/{repo}/contents/{path}
Source
github-v3-rest.json
Revision
f5f067c1e6f6
Active snapshot
85e53e3d0d65

Request

Path Parameters
owner string
required
repo string
required
path string
required

path parameter

Query Parameters
ref string
optional

The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)

Responses

application/json

Response

application/vnd.github.v3.object Content Tree object

Response

_links object
required
git string<uri>
requirednullable
html string<uri>
requirednullable
self string<uri>
required
download_url string<uri>
requirednullable
entries array[object]
optional
items object
_links object
required
git string<uri>
requirednullable
html string<uri>
requirednullable
self string<uri>
required
content string
optional
download_url string<uri>
requirednullable
git_url string<uri>
requirednullable
html_url string<uri>
requirednullable
name string
required
path string
required
sha string
required
size integer
required
type string
required
url string<uri>
required
git_url string<uri>
requirednullable
html_url string<uri>
requirednullable
name string
required
path string
required
sha string
required
size integer
required
type string
required
url string<uri>
required

Found

application/json Basic Error object

Forbidden

documentation_url string
optional
message string
optional
status string
optional
url string
optional
application/json Basic Error object

Resource not found

documentation_url string
optional
message string
optional
status string
optional
url string
optional