List every file path at a ref

GET/api/repos/{owner}/{repo}/paths

listRepositoryPaths

Returns every file path in the repository at the selected ref or commit, for a fuzzy file finder. Bounded: past the server's cap the list holds the shallow part of the tree and `truncated` is set.

Authentication is not described for this operation in the spec — that does not mean it is public. Check tokens and scopes.

curl

curl -X GET 'https://neosource.dev/api/repos/OWNER/REPO/paths'

fetch

fetch("https://neosource.dev/api/repos/OWNER/REPO/paths", {
  method: "GET",
});

Path parameters

ownerrequired: Repository owner or organization slug.
string
reporequired: Repository name.
string

Query parameters

ref: Bookmark name or full 40-hex commit id to list. Defaults to the repository's default branch.
string

Responses

200Repository file paths

application/json

RepoPathListResponse

object

Every file path in a repository at one commit: the "Go to file" corpus.

commit_oid: string | null
40-hex commit the reference resolved to. Absent only for a repository with no commits, whose list is empty.
pathsrequired: array
Repo-relative file paths, `/`-separated, sorted bytewise. Regular and executable files only: no directories, symlinks or submodules.
items
string
refrequired: string
The reference the list was resolved from, as requested (or the effective default branch when none was).
truncatedrequired: boolean
The tree was larger than the server lists; `paths` holds its shallow part (every file at one depth before any deeper one).

304`If-None-Match` names the current `ETag`; the stored list is still current

Standard errors

Bodies documented once for the whole API — see standard errors.

400Bad Request — one of: invalid_input
403Forbidden — one of: forbidden
404Not Found — one of: not_found
423Locked — one of: busy
429Rate limited — retry after the interval in the `Retry-After` header
500Internal server error
503Service temporarily unavailable / at capacity — retry after the `Retry-After` header
504Gateway timeout — the request exceeded the server's handling budget