{"_id":"5b0e13ffc4664e0003c75c2a","project":"5b0e13ffc4664e0003c75a66","__v":0,"version":{"_id":"5b0e13ffc4664e0003c75a67","project":"5b0e13ffc4664e0003c75a66","__v":4,"createdAt":"2015-09-17T16:58:03.490Z","releaseDate":"2015-09-17T16:58:03.490Z","categories":["5b0e13ffc4664e0003c75a68","5b0e13ffc4664e0003c75a69","5b0e13ffc4664e0003c75a6a","5b0e13ffc4664e0003c75a6b","5b0e13ffc4664e0003c75a6c","5b0e13ffc4664e0003c75a6d","5b0e13ffc4664e0003c75a6e","5b0e13ffc4664e0003c75a6f","5b0e13ffc4664e0003c75a70","5b0e13ffc4664e0003c75a71","5b0e13ffc4664e0003c75a72","5b0e13ffc4664e0003c75a73","5b0e13ffc4664e0003c75a74","5b0e13ffc4664e0003c75a75","5b0e13ffc4664e0003c75a76","5b0e13ffc4664e0003c75a77","5b0e13ffc4664e0003c75a89","5b0e13ffc4664e0003c75a8a","5b0e13ffc4664e0003c75a9d","5b0e13ffc4664e0003c75a9e","5b0e13ffc4664e0003c75a9f","5b0e13ffc4664e0003c75aa0","5b0e13ffc4664e0003c75aa1","5b0e13ffc4664e0003c75aa2","5b0e13ffc4664e0003c75aa3","5b0e13ffc4664e0003c75aa4","5b0e13ffc4664e0003c75aa5","5b0e13ffc4664e0003c75aa6","5b0e13ffc4664e0003c75aa7","5b0e13ffc4664e0003c75aa8","5b0e13ffc4664e0003c75aa9","5b0e13ffc4664e0003c75aaa","5b0e13ffc4664e0003c75aab","5b0e13ffc4664e0003c75aac","5b0e13ffc4664e0003c75aad","5b0e13ffc4664e0003c75aae","5b0e13ffc4664e0003c75aaf","5b0e13ffc4664e0003c75ab2","5bb3374f4306ad0003eb18e7","5bbf3c5373e72a000318362b","5bc065567d1cb0000384c649","5cbf19a5f9181f0033fbb968"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"5b0e13ffc4664e0003c75aa9","__v":0,"project":"5b0e13ffc4664e0003c75a66","version":"5b0e13ffc4664e0003c75a67","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-10-17T12:58:31.759Z","from_sync":false,"order":34,"slug":"folders-api-advance-access","title":"FOLDERS API (Advance Access)"},"parentDoc":null,"user":"566590c83889610d0008a253","githubsync":"","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-10-17T13:06:47.924Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":2,"body":"[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Heads Up!\",\n  \"body\": \"This page documents the Advance Access version (think \\\"beta\\\" but with fewer bugs) of the folders functionality.\"\n}\n[/block]\nThis call lists the contents of the specified folder.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://f4c-api.sbgenomics.com/v2/files/{folder_id}/list\",\n      \"language\": \"text\",\n      \"name\": \"Path\"\n    }\n  ]\n}\n[/block]\n##Request\n\n###Example request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /v2/files/6282d5e2121d43e7900e9d52b15845e7/list HTTP/1.1\\nHost: f4c-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\\nContent-Type: application/json\\nX-SBG-advance-access: advance\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl -X GET -H \\\"X-SBG-Auth-Token: c2e05946fb9a494ab5c19c72a94cb4ac\\\" -H \\\"x-sbg-advance-access: advance\\\" -H \\\"Content-Type: application/json\\\" \\\"http://f4c-api.sbgenomics.com/v2/files/57fb98c51c94d72f08ba0544/list\\\"\",\n      \"language\": \"curl\",\n      \"name\": \"cURL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n###Header Fields\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`X-SBG-Auth-Token`\\n*required*\",\n    \"0-1\": \"Your [authentication token](doc:get-your-authentication-token).\",\n    \"h-2\": \"\",\n    \"1-0\": \"`Content-Type`\\n*required*\",\n    \"1-1\": \"`application/json`\",\n    \"2-0\": \"`X-SBG-Advance-Access`\\nrequired\",\n    \"2-1\": \"`advance`\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n##Response\n\n[See a list of response codes that may be contained in the body of the response.](doc:api-status-codes)\n\n###Example response body \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/files/57fb98c51c94d72f08ba0544/list?offset=0&limit=5\\\",\\n  \\\"items\\\": [\\n    {\\n      \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/files/57fba0581c94d72f08ba054e\\\",\\n      \\\"id\\\": \\\"57fba0581c94d72f08ba054e\\\",\\n      \\\"name\\\": \\\"folder-name-1\\\",\\n      \\\"project\\\": \\\"rfranklin/my-project\\\",\\n      \\\"parent\\\": \\\"57fb98c51c94d72f08ba0544\\\",\\n      \\\"type\\\": \\\"FOLDER\\\"\\n    },\\n    {\\n      \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/files/57fba04c1c94d72f08ba054a\\\",\\n      \\\"id\\\": \\\"57fba04c1c94d72f08ba054a\\\",\\n      \\\"name\\\": \\\"file-name-1\\\",\\n      \\\"project\\\": \\\"rfranklin/my-project\\\",\\n      \\\"parent\\\": \\\"57fb98c51c94d72f08ba0544\\\",\\n      \\\"type\\\": \\\"FILE\\\"\\n    },\",\n      \"language\": \"json\",\n      \"name\": \"Example response body\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"files/{folder_id}/list","slug":"list-folder-contents","type":"endpoint","title":"List folder contents"}

getList folder contents

files/{folder_id}/list

[block:callout] { "type": "danger", "title": "Heads Up!", "body": "This page documents the Advance Access version (think \"beta\" but with fewer bugs) of the folders functionality." } [/block] This call lists the contents of the specified folder. [block:code] { "codes": [ { "code": "https://f4c-api.sbgenomics.com/v2/files/{folder_id}/list", "language": "text", "name": "Path" } ] } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "GET /v2/files/6282d5e2121d43e7900e9d52b15845e7/list HTTP/1.1\nHost: f4c-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\nContent-Type: application/json\nX-SBG-advance-access: advance", "language": "http", "name": null }, { "code": "curl -X GET -H \"X-SBG-Auth-Token: c2e05946fb9a494ab5c19c72a94cb4ac\" -H \"x-sbg-advance-access: advance\" -H \"Content-Type: application/json\" \"http://f4c-api.sbgenomics.com/v2/files/57fb98c51c94d72f08ba0544/list\"", "language": "curl", "name": "cURL" } ], "sidebar": true } [/block] ###Header Fields [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "`X-SBG-Auth-Token`\n*required*", "0-1": "Your [authentication token](doc:get-your-authentication-token).", "h-2": "", "1-0": "`Content-Type`\n*required*", "1-1": "`application/json`", "2-0": "`X-SBG-Advance-Access`\nrequired", "2-1": "`advance`" }, "cols": 2, "rows": 3 } [/block] ##Response [See a list of response codes that may be contained in the body of the response.](doc:api-status-codes) ###Example response body [block:code] { "codes": [ { "code": "{\n \"href\": \"https://f4c-api.sbgenomics.com/v2/files/57fb98c51c94d72f08ba0544/list?offset=0&limit=5\",\n \"items\": [\n {\n \"href\": \"https://f4c-api.sbgenomics.com/v2/files/57fba0581c94d72f08ba054e\",\n \"id\": \"57fba0581c94d72f08ba054e\",\n \"name\": \"folder-name-1\",\n \"project\": \"rfranklin/my-project\",\n \"parent\": \"57fb98c51c94d72f08ba0544\",\n \"type\": \"FOLDER\"\n },\n {\n \"href\": \"https://f4c-api.sbgenomics.com/v2/files/57fba04c1c94d72f08ba054a\",\n \"id\": \"57fba04c1c94d72f08ba054a\",\n \"name\": \"file-name-1\",\n \"project\": \"rfranklin/my-project\",\n \"parent\": \"57fb98c51c94d72f08ba0544\",\n \"type\": \"FILE\"\n },", "language": "json", "name": "Example response body" } ], "sidebar": true } [/block]