{"_id":"58f79daacbd001190056ca82","category":{"_id":"57f53fb368a53b2000e03f0f","version":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-10-05T18:00:19.547Z","from_sync":false,"order":0,"slug":"api","title":"REST API"},"parentDoc":null,"version":{"_id":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","__v":15,"createdAt":"2015-06-23T01:38:42.696Z","releaseDate":"2015-06-23T01:38:42.696Z","categories":["5588b8a3f6c18d0d005bba07","5588e9689cfea70d00371df3","5588f5921163180d00b64704","561598b121e9110d0078025a","5616f1c9d170d00d00189306","5616f5c3a410c90d00c6121e","561803dcf8c9632100ac7592","563667280441020d0000e9eb","5642570d9417b40d00c0fcd3","57bf5f02efe0050e00d50bd5","57f53fb368a53b2000e03f0f","57f55187440418170086325a","582e3afa72fd270f0006926d","5841faa973967b0f004b4a2b","58db348aa32c8419002433bb"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":0,"project":"5588b8a2f6c18d0d005bba03","user":"5588b847f6c18d0d005bba01","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-04-19T17:26:02.667Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"[\n  {\n    \"_id\": \"personal\",\n    \"name\": \"My sequences\"\n    \"count\": 7\n  },\n  {\n    \"_id\": \"shared\",\n    \"name\": \"Shared with me\",\n    \"count\": 4\n  }\n]","language":"json","status":200}]},"settings":"","examples":{"codes":[]},"method":"get","auth":"required","params":[],"url":"/v1/sequences/folders"},"isReference":true,"order":109,"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"_id\",\n    \"0-1\": \"String\",\n    \"0-2\": \"Identifier of the folder\",\n    \"1-0\": \"name\",\n    \"1-1\": \"String\",\n    \"1-2\": \"Name of the folder\",\n    \"2-0\": \"count\",\n    \"2-1\": \"Number\",\n    \"2-2\": \"Count of sequences existing in the folder\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]","excerpt":"Retrieve the list of folders available for the user. Currently limited to return the two fixed folders: \"personal\" containing sequences authored by a given user, and \"shared\" for sequences shared with the user.","slug":"sequencesfolders","type":"endpoint","title":"/sequences/folders"}

get/sequences/folders

Retrieve the list of folders available for the user. Currently limited to return the two fixed folders: "personal" containing sequences authored by a given user, and "shared" for sequences shared with the user.

Definition

{{ api_url }}{{ page_api_url }}

Result Format


Documentation

[block:parameters] { "data": { "h-0": "Parameter", "h-1": "Type", "h-2": "Description", "0-0": "_id", "0-1": "String", "0-2": "Identifier of the folder", "1-0": "name", "1-1": "String", "1-2": "Name of the folder", "2-0": "count", "2-1": "Number", "2-2": "Count of sequences existing in the folder" }, "cols": 3, "rows": 3 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}