Skip to main content
GET
A folder in a repo

Path Parameters

owner
string
required
Example:

"patch"

slug
string
required
Example:

"demo-mod"

Query Parameters

ref
string

A branch, a tag or a full commit hash: the default branch unless you say. A branch comes before a tag of the same name, and refs/tags/v1 says which.

Pattern: ^\S{1,255}$
Example:

"main"

path
string
default:""

A folder in the repo, from its top

Maximum string length: 4096
Example:

"docs/images"

Response

The folder

ref
string
required

The branch, tag or full commit hash it was asked for: the default branch unless given.

commit
string
required

The full commit hash that resolved to.

path
string
required

The folder, empty at the top of the repo.

entries
object[]
required

Folders first, then by name. They carry no sizes.

truncated
boolean
required

Whether any entries were left out: there are at most 5,000.