--- title: "A folder at any ref" description: "Folders first, then by name; 1,000 entries a page. Read by hash\nthrough the edge cache: a repeat view reaches no Artifacts call. A\nbranch name resolves from Pando's stored heads; a sha that is not in\nthis repo is a 404. No sizes (git trees have none).\n" --- > Documentation Index > Fetch the complete documentation index at: https://docs.gitpando.com/llms.txt > Use this file to discover all available pages before exploring further. Path: Pando API › repos `GET /v1/monorepos/{owner}/{monorepo}/repos/{repo}/tree` Folders first, then by name; 1,000 entries a page. Read by hash through the edge cache: a repeat view reaches no Artifacts call. A branch name resolves from Pando's stored heads; a sha that is not in this repo is a 404. No sizes (git trees have none). ## Authentication Requires one of the following: - `credential`, http, header `Authorization` - `session`, apiKey, in cookie ## Path parameters - `getTree.path.owner` (string, required) — The monorepo's owner, a namespace (a person's login or an organization). Matched without case. - pattern `^[a-z0-9](?:[a-z0-9]|-(?=[a-z0-9])){0,38}$` - `getTree.path.monorepo` (string, required) — The monorepo's name within its owner (or an old name). Matched without case. - pattern `^[a-z0-9](?:[a-z0-9._]|-(?!-)){0,38}$` - `getTree.path.repo` (string, required) — The repo's `name` (`projects-web`). ## Query parameters - `getTree.query.ref` (string, optional) — A branch name (`/` as is, URL-encoded) or a 40-character sha. Default: the default branch. - `getTree.query.path` (string, optional) — The folder, `a/b/c`. Default: the root. - `getTree.query.limit` (integer, optional) - min 1; max 1000; default `1000` - `getTree.query.cursor` (string, optional) — A `next` from an earlier page. ## Code samples ### cURL ```curl curl --request GET \ --url https://app.gitpando.com/v1/monorepos/string/string/repos/string/tree \ --header 'Authorization: Bearer ' ``` ### TypeScript ```typescript const url = 'https://app.gitpando.com/v1/monorepos/string/string/repos/string/tree'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err)); ``` ### Python ```python import requests url = "https://app.gitpando.com/v1/monorepos/string/string/repos/string/tree" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.text) ``` ## Responses ### 200 OK #### Example ```json { "ref": "string", "commit": "string", "path": "string", "entries": [ { "name": "string", "type": "dir", "mode": "string", "oid": "string" } ], "total": 0, "next": "string" } ``` - `getTree.response.200.ref` (string, required) - `getTree.response.200.commit` (string, required) — The commit the ref resolved to. - `getTree.response.200.path` (string, required) - `getTree.response.200.entries` (array, required) - `getTree.response.200.entries.name` (string, required) - `getTree.response.200.entries.type` (string, required) - one of `"dir"`, `"file"`, `"symlink"`, `"submodule"` - `getTree.response.200.entries.mode` (string, required) — git's mode: `100644`, `100755` (executable), `120000`, `40000`, `160000`. - `getTree.response.200.entries.oid` (string, required) — The object's hash (a blob for files; read it with raw). - `getTree.response.200.total` (integer, required) - `getTree.response.200.next` (string | null, required) ### 400 An error #### Example ```json { "error": { "code": "string", "message": "string", "paths": [ "string" ], "checks": { "sha": "string", "state": "success", "required": [ "string" ], "checks_unknown": "string", "missing": [ "string" ], "statuses": [ { "sha": "string", "context": "string", "state": "pending", "target_url": "string", "description": "string", "creator": "string", "app": "string", "created_at": "2019-08-24T14:15:22Z" } ] } } } ``` - `getTree.response.400.error` (object, required) - `getTree.response.400.error.code` (string, required) - `getTree.response.400.error.message` (string, required) - `getTree.response.400.error.paths` (array, optional) - `getTree.response.400.error.checks` (object, optional) — GitHub's combined status, plus the required contexts and which are missing. - `getTree.response.400.error.checks.sha` (string | null, required) - `getTree.response.400.error.checks.state` (string, required) — `success` when the merge gate passes; `missing` when a required context has not reported; `unknown` while the required checks are (an unforced merge is refused). - one of `"success"`, `"pending"`, `"failure"`, `"error"`, `"missing"`, `"unknown"` - `getTree.response.400.error.checks.required` (array | null, required) — Null while unknown. - `getTree.response.400.error.checks.checks_unknown` (string | null, required) — Why the required checks are unknown, in plain words: "Pando couldn't read this monorepo's required checks; try again", or "pando.toml line 3: expected comma or end of structure; fix it on main, or merge with force". Null otherwise. - `getTree.response.400.error.checks.statuses` (array, required) — The latest status per context. - `getTree.response.400.error.checks.statuses.sha` (string, required) - `getTree.response.400.error.checks.statuses.context` (string, required) - `getTree.response.400.error.checks.statuses.state` (string, required) - one of `"pending"`, `"success"`, `"failure"`, `"error"` - `getTree.response.400.error.checks.statuses.created_at` (string, required) - format `date-time` - `getTree.response.400.error.checks.statuses.target_url` (string | null, optional) - `getTree.response.400.error.checks.statuses.description` (string | null, optional) - `getTree.response.400.error.checks.statuses.creator` (string, optional) — The member who posted it (a login); `app:` for a status posted with a status token or by a CI integration; `hook:` for a status token from a web hook with no app. - `getTree.response.400.error.checks.statuses.app` (string | null, optional) — The CI service that reported it (`buildkite`, `github-actions`, ...), stamped by Pando from a status token or a CI integration, never from the body or `target_url`. Null when a member posted it with their own credential. The web shows the service's mark for a slug it knows. - `getTree.response.400.error.checks.missing` (array, optional) ### 404 `not_found` (ref, commit or path), or `not_a_folder`. #### Example ```json { "error": { "code": "string", "message": "string", "paths": [ "string" ], "checks": { "sha": "string", "state": "success", "required": [ "string" ], "checks_unknown": "string", "missing": [ "string" ], "statuses": [ { "sha": "string", "context": "string", "state": "pending", "target_url": "string", "description": "string", "creator": "string", "app": "string", "created_at": "2019-08-24T14:15:22Z" } ] } } } ``` - `getTree.response.404.error` (object, required) - `getTree.response.404.error.code` (string, required) - `getTree.response.404.error.message` (string, required) - `getTree.response.404.error.paths` (array, optional) - `getTree.response.404.error.checks` (object, optional) — GitHub's combined status, plus the required contexts and which are missing. - `getTree.response.404.error.checks.sha` (string | null, required) - `getTree.response.404.error.checks.state` (string, required) — `success` when the merge gate passes; `missing` when a required context has not reported; `unknown` while the required checks are (an unforced merge is refused). - one of `"success"`, `"pending"`, `"failure"`, `"error"`, `"missing"`, `"unknown"` - `getTree.response.404.error.checks.required` (array | null, required) — Null while unknown. - `getTree.response.404.error.checks.checks_unknown` (string | null, required) — Why the required checks are unknown, in plain words: "Pando couldn't read this monorepo's required checks; try again", or "pando.toml line 3: expected comma or end of structure; fix it on main, or merge with force". Null otherwise. - `getTree.response.404.error.checks.statuses` (array, required) — The latest status per context. - `getTree.response.404.error.checks.statuses.sha` (string, required) - `getTree.response.404.error.checks.statuses.context` (string, required) - `getTree.response.404.error.checks.statuses.state` (string, required) - one of `"pending"`, `"success"`, `"failure"`, `"error"` - `getTree.response.404.error.checks.statuses.created_at` (string, required) - format `date-time` - `getTree.response.404.error.checks.statuses.target_url` (string | null, optional) - `getTree.response.404.error.checks.statuses.description` (string | null, optional) - `getTree.response.404.error.checks.statuses.creator` (string, optional) — The member who posted it (a login); `app:` for a status posted with a status token or by a CI integration; `hook:` for a status token from a web hook with no app. - `getTree.response.404.error.checks.statuses.app` (string | null, optional) — The CI service that reported it (`buildkite`, `github-actions`, ...), stamped by Pando from a status token or a CI integration, never from the body or `target_url`. Null when a member posted it with their own credential. The web shows the service's mark for a slug it knows. - `getTree.response.404.error.checks.missing` (array, optional) Source: https://docs.gitpando.com/api/repos/getTree/index.md