GET
/
repos
/
{repo_id}
/
trees
/
{ref_id}
/
{path}

Authorizations

​
Authorization
string
headerrequired

This API uses OAuth 2 with the implicit grant flow

Path Parameters

​
repo_id
string
required

The repo ID of the repository. Repo name can be used instead of the ID, but usage of ID for permanent linking and API requests is preferred.

Required string length: 3 - 128
​
ref_id
string
required

An ID of a workspace, branch or commit.

Required string length: 3 - 128
​
path
string
required

A path to a file inside the repository.

Query Parameters

​
recurse
boolean
default: true

Specifies if to recursively iterate file tree to next directory levels

​
skip
integer

Skip a number of items returned from a listing api

Required range: x > 0
​
limit
integer

Limit the number of entries returned from walk

Required range: x > 1
​
offset
string

Offset item name in directory when iterating its entries (non-inclusive)

​
include_deleted
boolean
default: false

Should the tree contain also deleted items or omit them from response

​
workspace_journal_ordinal_id
integer

The ordinal ID of the journal entry the walk references, if applicable

​
dirs_only
boolean
default: false

Return only directories in the file tree walk

Response

200 - application/json
​
object
enum<string>
required
Available options:
FileEntry
​
items
object[]
required
​
workspace_journal_ordinal_id
integer

An ordinal ID of a workspace journal entry

Get file tree snapshot. Either one of workspace, branch or commit ID needs to be specified as ref ID.Get object history in a ref by its latest path