Skip to main content
GET
/
v1
/
shelves
/
{id}
/
tree
Get shelf file tree
curl --request GET \
  --url https://api.shelv.dev/v1/shelves/{id}/tree \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.shelv.dev/v1/shelves/{id}/tree"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.shelv.dev/v1/shelves/{id}/tree', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.shelv.dev/v1/shelves/{id}/tree', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "fileCount": 123,
  "files": {},
  "name": "<string>",
  "shelfPublicId": "<string>"
}
{
  "code": "<string>",
  "message": "<string>",
  "details": "<unknown>"
}
{
  "code": "<string>",
  "message": "<string>",
  "details": "<unknown>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required
Pattern: ^shf_[0-9a-f]{24}$

Response

File tree with contents

fileCount
number
required
files
object
required
name
string
required
shelfPublicId
string
required
Pattern: ^shf_[0-9a-f]{24}$