Get repository directory tree¶

GET /api/v5/repos/{owner}/{repo}/git/trees/{sha}

This endpoint retrieves the directory file tree of the specified repository. You can locate the version by branch name, commit, or directory tree SHA. It supports recursively retrieving subdirectories and viewing directory entries with pagination.

Access token support¶

• AtomGit user access tokens (AtomGit user access tokens)

Anonymous access¶

This endpoint allows anonymous access.

Request parameters¶

Response parameters¶

tree object

Error responses¶

This endpoint may return the following common error status codes. The field names in the error response body are subject to the actual backend response.

400 Invalid parameters

{
  "message": "Invalid parameters"
}

401 Unauthenticated

{
  "message": "Missing or invalid access token"
}

404 Resource not found

{
  "message": "The repository or directory tree does not exist"
}

HTTP response status codes¶

Request example¶

Parameter notes¶

• This endpoint allows anonymous access, so the examples do not include authentication information. To access a private repository, you can include an AtomGit user access token.
• Replace <owner> with the namespace address the repository belongs to (organization or personal path);
• Replace <repo> with the repository path (path);
• Replace <sha> with a branch name, a commit, or the SHA of a directory tree.

cURL¶

curl -X GET 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/git/trees/<sha>' \
  -H 'Accept: application/json'

To retrieve directories recursively, append the query parameter recursive=1:

curl -X GET 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/git/trees/<sha>?recursive=1' \
  -H 'Accept: application/json'

JavaScript¶

// Native fetch (Node.js 18+ / browser)
const response = await fetch(
  "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/git/trees/<sha>",
  {
    headers: {
      "Accept": "application/json",
    },
  },
);

if (!response.ok) {
  throw new Error(`Request failed: ${response.status}`);
}

const data = await response.json();
console.log(data);

Python¶

import requests

resp = requests.get(
    "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/git/trees/<sha>",
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

Response example¶

Status code: 200

{
  "tree": [
    {
      "sha": "5259c4b24f015ffdc3663e81837a730c2a108e1f",
      "name": "b",
      "type": "tree",
      "path": "a/b",
      "mode": "040000",
      "md5": "a7e86136543b019d72468ceebf71fb8e"
    }
  ]
}

Error codes¶