GuidesAPI ReferenceRelease NotesTutorials

List folder contents

files/{folder_id}/list

❗️

Heads Up!

This page documents the Advance Access version (think "beta" but with fewer bugs) of the folders functionality.

This call lists the contents of the specified folder.

https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/files/{folder_id}/list

Request

Example request

GET /v2/files/6282d5e2121d43e7900e9d52b15845e7/list HTTP/1.1
Host: api.sb.biodatacatalyst.nhlbi.nih.gov
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74
Content-Type: application/json
X-SBG-advance-access: advance

curl -X GET -H "X-SBG-Auth-Token: c2e05946fb9a494ab5c19c72a94cb4ac" -H "x-sbg-advance-access: advance" -H "Content-Type: application/json" "http://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/files/57fb98c51c94d72f08ba0544/list"

Header Fields

NameDescription
X-SBG-Auth-Token
required		Your authentication token.
Content-Type
required		application/json
X-SBG-Advance-Access
required		advance

Response

See a list of response codes that may be contained in the body of the response.

Example response body 

{
  "href": "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/files/57fb98c51c94d72f08ba0544/list?offset=0&limit=5",
  "items": [
    {
      "href": "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/files/57fba0581c94d72f08ba054e",
      "id": "57fba0581c94d72f08ba054e",
      "name": "folder-name-1",
      "project": "rfranklin/my-project",
      "parent": "57fb98c51c94d72f08ba0544",
      "type": "FOLDER"
    },
    {
      "href": "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/files/57fba04c1c94d72f08ba054a",
      "id": "57fba04c1c94d72f08ba054a",
      "name": "file-name-1",
      "project": "rfranklin/my-project",
      "parent": "57fb98c51c94d72f08ba0544",
      "type": "FILE"
    },