Get shelf file listing
curl --request GET \
--url https://api.shelv.dev/v1/shelves/{id}/listing \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.shelv.dev/v1/shelves/{id}/listing"
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}/listing', 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}/listing', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"fileCount": 123,
"name": "<string>",
"paths": [
"<string>"
],
"shelfPublicId": "<string>"
}{
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}Shelves
Get shelf file listing
Get the list of file paths in a shelf without content. Only available when the shelf is in ready or review status.
GET
/
v1
/
shelves
/
{id}
/
listing
Get shelf file listing
curl --request GET \
--url https://api.shelv.dev/v1/shelves/{id}/listing \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.shelv.dev/v1/shelves/{id}/listing"
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}/listing', 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}/listing', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"fileCount": 123,
"name": "<string>",
"paths": [
"<string>"
],
"shelfPublicId": "<string>"
}{
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Pattern:
^shf_[0-9a-f]{24}$